Targets

Package:

targets.triggermesh.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the targets/v1alpha1 API group.

Resource Types:

AWSComprehendTarget

AWSComprehendTarget is the Schema for an AWS Comprehend Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSComprehendTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSComprehendTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

region
string

Region to use for calling into Comprehend API.

eventOptions
EventOptions

EventOptions for targets.

language
string

Language code to use to interact with Comprehend. The supported list can be found at: https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSDynamoDBTarget

AWSDynamoDBTarget is the Schema for an AWS DynamoDB Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSDynamoDBTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSDynamoDBTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Table ARN https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html#amazondynamodb-resources-for-iam-policies

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSEventBridgeTarget

AWSEventBridgeTarget is the Schema for the event target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSEventBridgeTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSEventBridgeTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the EventBridge Event Bus. https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in notifications sent to EventBridge. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSKinesisTarget

AWSKinesisTarget is the Schema for an AWS Kinesis Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSKinesisTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSKinesisTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the Kinesis stream. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonkinesis.html#amazonkinesis-resources-for-iam-policies

partition
string

Kinesis Partition to publish the events to

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in records created in Kinesis. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSLambdaTarget

AWSLambdaTarget is the Schema for an AWS Lambda Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSLambdaTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSLambdaTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the Lambda function. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html#awslambda-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in Lambda function calls. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSS3Target

AWSS3Target is the Schema for an AWS s3 Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSS3Target
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSS3TargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the S3 bucket. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in objects created in S3. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSSNSTarget

AWSSNSTarget is the Schema for the event target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSSNSTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSSNSTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the SNS topic. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html#amazonsns-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in notifications sent to SNS. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSSQSTarget

AWSSQSTarget is the Schema for an AWS SQS Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AWSSQSTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AWSSQSTargetSpec


auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the SQS queue. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsqs.html#amazonsqs-resources-for-iam-policies

messageGroupId
string
(Optional)

Message Group ID is required for FIFO based queues, and is used to uniquely identify the event producer https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to SQS. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AzureEventHubsTarget

AzureEventHubsTarget is the Schema for an Azure Object Storage Service Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AzureEventHubsTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AzureEventHubsTargetSpec


auth
AzureAuth

Authentication method to interact with the Azure Event Hubs API.

eventHubID
EventHubResourceID

Resource ID of the Event Hubs instance.

Expected format: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}

eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool
adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AzureSentinelTarget

AzureSentinelTarget is the Schema for an Azure Sentinel Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
AzureSentinelTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AzureSentinelTargetSpec


subscriptionID
string

SubscriptionID refers to the Azure Subscription ID that the Azure Sentinel instance is associated with.

resourceGroup
string

ResourceGroup refers to the resource group where the Azure Sentinel instance is deployed.

workspace
string

Workspace refers to the workspace name in Azure Sentinel.

auth
AzureAuth

Authentication method to interact with the Azure Event Hubs API.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

CloudEventsTarget

CloudEventsTarget is a gateway that produces received CloudEvents to a destination.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
CloudEventsTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
CloudEventsTargetSpec


credentials
CloudEventsCredentials
(Optional)

Credentials to connect to the remote endpoint.

path
string
(Optional)

Path at the remote endpoint under which requests are accepted.

endpoint
knative.dev/pkg/apis.URL

Endpoint that accept CloudEvents.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

AdapterOverrides sets runtime parameters to the adapter instance.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

DatadogTarget

DatadogTarget is the Schema for an HTTP Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
DatadogTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
DatadogTargetSpec


apiKey
SecretValueFromSource

DatadogApiKey represents how Datadog credentials should be provided in the secret

metricPrefix
string
(Optional)

MetricPrefix is prepended to the name of the associated metrics.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

ElasticsearchTarget

ElasticsearchTarget is the Schema for an Elasticsearch Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
ElasticsearchTarget
metadata
Kubernetes meta/v1.ObjectMeta
(Optional) Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ElasticsearchTargetSpec


connection
Connection
(Optional)

Connection information to elasticsearch.

indexName
string

IndexName to write to.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in documents created in Elasticsearch. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

GoogleCloudFirestoreTarget

GoogleCloudFirestoreTarget is the Schema for the GoogleCloudFirestore Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
GoogleCloudFirestoreTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GoogleCloudFirestoreTargetSpec


credentialsJson
SecretValueFromSource

Credentials represents how Google Firestore credentials should be provided in the secret

defaultCollection
string

DefaultCollection sets a default Firestore collection to select from

projectID
string

ProjectID specifies the Google project ID

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in documents created in Firestore. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

GoogleCloudPubSubTarget

GoogleCloudPubSubTarget is the Schema the event target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
GoogleCloudPubSubTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GoogleCloudPubSubTargetSpec


topic
GCloudResourceName

Full resource name of the Pub/Sub topic to subscribe to, in the format “projects/{project_name}/topics/{topic_name}”.

credentialsJson
SecretValueFromSource

Service account key in JSON format. https://cloud.google.com/iam/docs/creating-managing-service-account-keys

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool

DiscardCloudEventContext is the policy for how to handle the payload of the CloudEvent.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

GoogleCloudStorageTarget

GoogleCloudStorageTarget is the Schema for an Google Storage Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
GoogleCloudStorageTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GoogleCloudStorageTargetSpec


credentialsJson
SecretValueFromSource

Credentials represents how Google Storage credentials should be provided in the secret

bucketName
string

BucketName specifies the Google Storage Bucket

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in objects created in Google Cloud Storage. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

GoogleCloudWorkflowsTarget

GoogleCloudWorkflowsTarget is the Schema for an Google Cloud Workflows Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
GoogleCloudWorkflowsTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GoogleCloudWorkflowsTargetSpec


credentialsJson
SecretValueFromSource

GoogleCloudWorkflowsApiKey represents how GoogleCloudWorkflows credentials should be provided in the secret

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

GoogleSheetTarget

GoogleSheetTarget is the Schema for an GoogleSheet Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
GoogleSheetTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
GoogleSheetTargetSpec


googleServiceAccount
SecretValueFromSource

GoogleSheet credential JSON for auth

id
string

ID of Google a spreadsheet

defaultPrefix
string

DefaultPrefix is a pre-defined prefix for the individual sheets.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

HTTPTarget

HTTPTarget is the Schema for an HTTP Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
HTTPTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
HTTPTargetSpec


response
HTTPEventResponse

Response data to be used at replies.

endpoint
knative.dev/pkg/apis.URL

Endpoint to connect to.

method
string

Method to use at requests.

headers
map[string]string
(Optional)

Headers to be included at HTTP requests

skipVerify
bool
(Optional)

SkipVerify disables server certificate validation.

caCertificate
string
(Optional)

CACertificate uses the CA certificate to verify the remote server certificate.

basicAuthUsername
string
(Optional)

BasicAuthUsername used for basic authentication.

basicAuthPassword
SecretValueFromSource
(Optional)

BasicAuthPassword used for basic authentication.

oauthClientID
string
(Optional)

OAuthClientID used for OAuth2 authentication.

oauthClientSecret
SecretValueFromSource
(Optional)

OAuthClientSecret used for OAuth2 authentication.

oauthTokenURL
string
(Optional)

OAuthTokenURL used for OAuth2 authentication.

oauthScopes
[]string
(Optional)

OAuthScopes used for OAuth2 authentication.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

IBMMQTarget

IBMMQTarget is the Schema the event target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
IBMMQTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
IBMMQTargetSpec


connectionName
string
queueManager
string
queueName
string
channelName
string
replyTo
MQReplyOptions
credentials
Credentials
eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to MQ. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

JiraTarget

JiraTarget is the Schema for the Jira Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
JiraTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
JiraTargetSpec


auth
JiraAuth

Authentication to interact with the Salesforce API.

url
string

URL for Jira service.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

KafkaTarget

KafkaTarget is the Schema for an KafkaTarget.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
KafkaTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
KafkaTargetSpec


topic
string

Topic where messages are produced.

topicReplicationFactor
int16
(Optional)

TopicReplicationFactor is the number of replicas for the topic.

topicPartitions
int32
(Optional)

TopicPartitions is the number of partitions for the topic.

bootstrapServers
[]string

BootstrapServers holds the name of the Kafka Bootstrap server.

auth
KafkaTargetAuth
(Optional)

Auth contains Authentication method used to interact with Kafka.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Kafka. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

LogzMetricsTarget

LogzMetricsTarget receives CloudEvents typed io.triggermesh.opentelemetry.metrics.push that fullfil the schema at https://docs.triggermesh.io/schemas/opentelemetry.metrics.push.json to push new observations.

The target works using an OpenTelemetry to Cortex adapter, and is able to manage OpenTelemetry Synchronous Kinds. In case of an error a CloudEvent response conformant with https://docs.triggermesh.io/schemas/triggermesh.error.json and with an the attribute extension category: error can be produced.

Due to the buffering nature of this target, not returning an error does not guarantee that the metrics have been pushed to Logz

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
LogzMetricsTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
LogzMetricsTargetSpec


connection
LogzMetricsConnection

Connection information for LogzMetrics.

instruments
[]Instrument

Instruments configured for pushing metrics. It is mandatory that all metrics pushed by using this target are pre-registered using this list.

eventOptions
EventOptions
(Optional)

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

LogzTarget

LogzTarget is the Schema for the Logz Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
LogzTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
LogzTargetSpec


shippingToken
SecretValueFromSource

ShippingToken defines the API token.

logsListenerURL
string

LogsListenerURL Defines the Log listener URL

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

MongoDBTarget

MongoDBTarget is the Schema for the MongoDB Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
MongoDBTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
MongoDBTargetSpec


connectionString
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

ConnectionString defines the MongoDB connection string.

database
string

Database defines the MongoDB database.

collection
string

Collection defines the MongoDB collection.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

OracleTarget

OracleTarget is the Schema for an Oracle Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
OracleTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
OracleTargetSpec


oracleApiPrivateKey
SecretValueFromSource

Oracle User API private key.

oracleApiPrivateKeyPassphrase
SecretValueFromSource

Oracle User API private key passphrase.

oracleApiPrivateKeyFingerprint
SecretValueFromSource

Oracle User API cert fingerprint.

oracleTenancy
string

Oracle Tenancy OCID.

oracleUser
string

Oracle User OCID associated with the API key.

oracleRegion
string

Oracle Cloud Region.

function
OracleFunctionSpecSpec
adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

SalesforceTarget

SalesforceTarget receives CloudEvents typed io.triggermesh.salesforce.apicall that fullfil the schema at https://docs.triggermesh.io/schemas/salesforce.apicall.json and consumes the Salesforce API.

Upon a successful call a response is returned typed io.triggermesh.salesforce.apicall.response containing the returned payload as the CloudEvent data and a category: success extension. In case of an error the payload will be conformant with https://docs.triggermesh.io/schemas/triggermesh.error.json and the CloudEvent extension will be set to category: error.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
SalesforceTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SalesforceTargetSpec


auth
SalesforceAuth

Authentication information to interact with the Salesforce API.

apiVersion
string
(Optional)

APIVersion at Salesforce. If not set the latest version will be used.

eventOptions
EventOptions
(Optional)

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

SendGridTarget

SendGridTarget is the Schema for an Sendgrid Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
SendGridTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SendGridTargetSpec


apiKey
SecretValueFromSource

APIKey for account

defaultFromEmail
string
(Optional)

DefaultFromEmail is a default email account to assign to the outgoing email’s.

defaultToEmail
string
(Optional)

DefaultToEmail is a default recipient email account to assign to the outgoing email’s.

defaultToName
string
(Optional)

DefaultToName is a default recipient name to assign to the outgoing email’s.

defaultFromName
string
(Optional)

DefaultFromName is a default sender name to assign to the outgoing email’s.

defaultMessage
string
(Optional)

DefaultMessage is a default message to assign to the outgoing email’s.

defaultSubject
string
(Optional)

DefaultSubject is a default subject to assign to the outgoing email’s.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

SlackTarget

SlackTarget defines the schema for the Slack target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
SlackTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SlackTargetSpec


token
SecretValueFromSource

Token for Slack App

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

SolaceTarget

SolaceTarget is the Schema for an SolaceTarget.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
SolaceTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SolaceTargetSpec


url
string

URL

queueName
string

QueueName

auth
SolaceTargetAuth
(Optional)

Auth contains Authentication method used to interact with Solace.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Solace. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

SplunkTarget

SplunkTarget is the Schema for the event target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
SplunkTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SplunkTargetSpec


endpoint
knative.dev/pkg/apis.URL

URL of the HTTP Event Collector (HEC). Only the scheme, hostname, and port (optionally) are evaluated, the URL path is trimmed if present. see https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector#Enable_HTTP_Event_Collector

token
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

Token for authenticating requests against the HEC. see https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector#About_Event_Collector_tokens

index
string
(Optional)

Name of the index to send events to. When undefined, events are sent to the default index defined in the HEC token’s configuration.

skipTLSVerify
bool
(Optional)

Controls whether the Splunk client verifies the server’s certificate chain and host name when communicating over TLS.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Splunk. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

TwilioTarget

TwilioTarget is the Schema for an Twilio Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
TwilioTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TwilioTargetSpec


sid
SecretValueFromSource

Twilio account SID

token
SecretValueFromSource

Twilio account Token

defaultPhoneFrom
string
(Optional)

DefaultPhoneFrom is the purchased Twilio phone we are using

defaultPhoneTo
string
(Optional)

DefaultPhoneTo is the destination phone

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

ZendeskTarget

ZendeskTarget is the Schema for an Zendesk Target.

Field Description
apiVersion
string
targets.triggermesh.io/v1alpha1
kind
string
ZendeskTarget
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ZendeskTargetSpec


token
SecretValueFromSource

Token contains the Zendesk account Token.

subdomain
string

Subdomain the Zendesk subdomain.

email
string

Email the registered Zendesk email account.

subject
string
(Optional)

Subject a static subject assignemnt for every ticket.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

status
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.Status

AWSComprehendTargetSpec

(Appears on: AWSComprehendTarget)

AWSComprehendTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

region
string

Region to use for calling into Comprehend API.

eventOptions
EventOptions

EventOptions for targets.

language
string

Language code to use to interact with Comprehend. The supported list can be found at: https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSDynamoDBTargetSpec

(Appears on: AWSDynamoDBTarget)

AWSDynamoDBTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Table ARN https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html#amazondynamodb-resources-for-iam-policies

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSEventBridgeTargetSpec

(Appears on: AWSEventBridgeTarget)

AWSEventBridgeTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the EventBridge Event Bus. https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazoneventbridge.html

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in notifications sent to EventBridge. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSKinesisTargetSpec

(Appears on: AWSKinesisTarget)

AWSKinesisTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the Kinesis stream. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonkinesis.html#amazonkinesis-resources-for-iam-policies

partition
string

Kinesis Partition to publish the events to

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in records created in Kinesis. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSLambdaTargetSpec

(Appears on: AWSLambdaTarget)

AWSLambdaTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the Lambda function. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awslambda.html#awslambda-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in Lambda function calls. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSS3TargetSpec

(Appears on: AWSS3Target)

AWSS3TargetSpec holds the desired state of the even target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the S3 bucket. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in objects created in S3. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSSNSTargetSpec

(Appears on: AWSSNSTarget)

AWSSNSTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the SNS topic. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsns.html#amazonsns-resources-for-iam-policies

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in notifications sent to SNS. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AWSSQSTargetSpec

(Appears on: AWSSQSTarget)

AWSSQSTargetSpec defines the desired state of the event target.

Field Description
auth
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AWSAuth

AWS-specific authentication methods.

arn
string

Amazon Resource Name of the SQS queue. https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonsqs.html#amazonsqs-resources-for-iam-policies

messageGroupId
string
(Optional)

Message Group ID is required for FIFO based queues, and is used to uniquely identify the event producer https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to SQS. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AzureAuth

(Appears on: AzureEventHubsTargetSpec, AzureSentinelTargetSpec)

AzureAuth contains multiple authentication methods for Azure services.

Field Description
servicePrincipal
AzureServicePrincipal

Service principals provide a way to create a non-interactive account associated with your identity to which you grant only the privileges your app needs to run. See https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals

sasToken
AzureSASToken

A shared access signature (SAS) provides secure delegated access to resources in a storage account. See https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview

AzureEventHubsTargetSpec

(Appears on: AzureEventHubsTarget)

AzureEventHubsTargetSpec defines the desired state of the event target.

Field Description
auth
AzureAuth

Authentication method to interact with the Azure Event Hubs API.

eventHubID
EventHubResourceID

Resource ID of the Event Hubs instance.

Expected format: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}

eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool
adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AzureSASToken

(Appears on: AzureAuth)

AzureSASToken represents an Azure SAS token.

Field Description
keyName
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
keyValue
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
connectionString
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

AzureSentinelTargetSpec

(Appears on: AzureSentinelTarget)

AzureSentinelTargetSpec holds the desired state of the event target.

Field Description
subscriptionID
string

SubscriptionID refers to the Azure Subscription ID that the Azure Sentinel instance is associated with.

resourceGroup
string

ResourceGroup refers to the resource group where the Azure Sentinel instance is deployed.

workspace
string

Workspace refers to the workspace name in Azure Sentinel.

auth
AzureAuth

Authentication method to interact with the Azure Event Hubs API.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

AzureServicePrincipal

(Appears on: AzureAuth)

AzureServicePrincipal represents an AAD Service Principal.

Field Description
tenantID
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientID
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientSecret
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

CloudEventsCredentials

(Appears on: CloudEventsTargetSpec)

CloudEventsCredentials to be used when sending requests.

Field Description
basicAuth
HTTPBasicAuth

CloudEventsTargetSpec

(Appears on: CloudEventsTarget)

CloudEventsTargetSpec defines the desired state of the event target.

Field Description
credentials
CloudEventsCredentials
(Optional)

Credentials to connect to the remote endpoint.

path
string
(Optional)

Path at the remote endpoint under which requests are accepted.

endpoint
knative.dev/pkg/apis.URL

Endpoint that accept CloudEvents.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

AdapterOverrides sets runtime parameters to the adapter instance.

Connection

(Appears on: ElasticsearchTargetSpec)

Connection contains connection and configuration parameters

Field Description
addresses
[]string

Array of hostnames or IP addresses to connect the target to.

caCert
string

CA Certificate used to verify connection with the Elasticsearch instance.

skipVerify
bool

Skip verification of the SSL certificate during the connection.

username
string

Elasticsearch account username.

password
SecretValueFromSource

Elasticsearch account password.

apiKey
SecretValueFromSource

When informed supersedes username and password.

Credentials

(Appears on: IBMMQTargetSpec)

Credentials holds the auth details.

Field Description
username
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
password
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
tls
TLSSpec

DatadogTargetSpec

(Appears on: DatadogTarget)

DatadogTargetSpec defines the desired state of the event target.

Field Description
apiKey
SecretValueFromSource

DatadogApiKey represents how Datadog credentials should be provided in the secret

metricPrefix
string
(Optional)

MetricPrefix is prepended to the name of the associated metrics.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

ElasticsearchTargetSpec

(Appears on: ElasticsearchTarget)

ElasticsearchTargetSpec defines the desired state of the event target.

Field Description
connection
Connection
(Optional)

Connection information to elasticsearch.

indexName
string

IndexName to write to.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in documents created in Elasticsearch. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

EventHubResourceID

(Appears on: AzureEventHubsTargetSpec)

EventHubResourceID represents a resource ID for an Event Hubs instance or namespace.

Field Description
SubscriptionID
string
ResourceGroup
string
Namespace
string
EventHub
string

EventOptions

(Appears on: AWSComprehendTargetSpec, AzureEventHubsTargetSpec, AzureSentinelTargetSpec, DatadogTargetSpec, ElasticsearchTargetSpec, GoogleCloudFirestoreTargetSpec, GoogleCloudPubSubTargetSpec, GoogleCloudStorageTargetSpec, GoogleCloudWorkflowsTargetSpec, IBMMQTargetSpec, LogzMetricsTargetSpec, LogzTargetSpec, MongoDBTargetSpec, SalesforceTargetSpec, SendGridTargetSpec, TwilioTargetSpec)

EventOptions modifies CloudEvents management at Targets.

Field Description
payloadPolicy
github.com/triggermesh/triggermesh/pkg/targets/adapter/cloudevents.PayloadPolicy
(Optional)

PayloadPolicy indicates if replies from the target should include a payload if available. Possible values are:

  • always: will return a with the reply payload if avaliable.
  • errors: will only reply with payload in case of an error.
  • never: will not reply with payload.

GCloudResourceName

(Appears on: GoogleCloudPubSubTargetSpec)

GCloudResourceName represents a fully qualified resource name, as described at

https://cloud.google.com/apis/design/resource_names

Examples of such resource names include: - projects/{project_name}/topics/{topic_name} - projects/{project_name}/repos/{repo_name} - projects/{project_name}/subscriptions/{subscription_name}

Field Description
Project
string
Collection
string
Resource
string

GoogleCloudFirestoreTargetSpec

(Appears on: GoogleCloudFirestoreTarget)

GoogleCloudFirestoreTargetSpec defines the desired state of the event target.

Field Description
credentialsJson
SecretValueFromSource

Credentials represents how Google Firestore credentials should be provided in the secret

defaultCollection
string

DefaultCollection sets a default Firestore collection to select from

projectID
string

ProjectID specifies the Google project ID

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in documents created in Firestore. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

GoogleCloudPubSubTargetSpec

(Appears on: GoogleCloudPubSubTarget)

GoogleCloudPubSubTargetSpec holds the desired state of the event target.

Field Description
topic
GCloudResourceName

Full resource name of the Pub/Sub topic to subscribe to, in the format “projects/{project_name}/topics/{topic_name}”.

credentialsJson
SecretValueFromSource

Service account key in JSON format. https://cloud.google.com/iam/docs/creating-managing-service-account-keys

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool

DiscardCloudEventContext is the policy for how to handle the payload of the CloudEvent.

GoogleCloudPubSubTargetStatus

GoogleCloudPubSubTargetStatus communicates the observed state of the event target.

Field Description
Status
knative.dev/pkg/apis/duck/v1.Status

(Members of Status are embedded into this type.)

AddressStatus
knative.dev/pkg/apis/duck/v1.AddressStatus

(Members of AddressStatus are embedded into this type.)

GoogleCloudStorageTargetSpec

(Appears on: GoogleCloudStorageTarget)

GoogleCloudStorageTargetSpec defines the desired state of the event target.

Field Description
credentialsJson
SecretValueFromSource

Credentials represents how Google Storage credentials should be provided in the secret

bucketName
string

BucketName specifies the Google Storage Bucket

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in objects created in Google Cloud Storage. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

GoogleCloudWorkflowsTargetSpec

(Appears on: GoogleCloudWorkflowsTarget)

GoogleCloudWorkflowsTargetSpec defines the desired state of the event target.

Field Description
credentialsJson
SecretValueFromSource

GoogleCloudWorkflowsApiKey represents how GoogleCloudWorkflows credentials should be provided in the secret

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

GoogleSheetTargetSpec

(Appears on: GoogleSheetTarget)

GoogleSheetTargetSpec defines the desired state of the event target.

Field Description
googleServiceAccount
SecretValueFromSource

GoogleSheet credential JSON for auth

id
string

ID of Google a spreadsheet

defaultPrefix
string

DefaultPrefix is a pre-defined prefix for the individual sheets.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

HTTPBasicAuth

(Appears on: CloudEventsCredentials)

HTTPBasicAuth credentials.

Field Description
username
string
password
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

HTTPEventResponse

(Appears on: HTTPTargetSpec)

HTTPEventResponse for reply events context.

Field Description
eventType
string

EventType for the reply.

eventSource
string

EventSource for the reply.

HTTPTargetSpec

(Appears on: HTTPTarget)

HTTPTargetSpec defines the desired state of the event target.

Field Description
response
HTTPEventResponse

Response data to be used at replies.

endpoint
knative.dev/pkg/apis.URL

Endpoint to connect to.

method
string

Method to use at requests.

headers
map[string]string
(Optional)

Headers to be included at HTTP requests

skipVerify
bool
(Optional)

SkipVerify disables server certificate validation.

caCertificate
string
(Optional)

CACertificate uses the CA certificate to verify the remote server certificate.

basicAuthUsername
string
(Optional)

BasicAuthUsername used for basic authentication.

basicAuthPassword
SecretValueFromSource
(Optional)

BasicAuthPassword used for basic authentication.

oauthClientID
string
(Optional)

OAuthClientID used for OAuth2 authentication.

oauthClientSecret
SecretValueFromSource
(Optional)

OAuthClientSecret used for OAuth2 authentication.

oauthTokenURL
string
(Optional)

OAuthTokenURL used for OAuth2 authentication.

oauthScopes
[]string
(Optional)

OAuthScopes used for OAuth2 authentication.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

IBMMQTargetSpec

(Appears on: IBMMQTarget)

IBMMQTargetSpec defines the desired state of the event target.

Field Description
connectionName
string
queueManager
string
queueName
string
channelName
string
replyTo
MQReplyOptions
credentials
Credentials
eventOptions
EventOptions

EventOptions for targets

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to MQ. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

Instrument

(Appears on: LogzMetricsTargetSpec)

Instrument push metrics for.

Field Description
name
string

Name for the Instrument.

description
string
(Optional)

Description for the Instrument

instrument
InstrumentKind

Instrument Kind as defined by OpenTelemetry. Supported values are:

  • Histogram: for absolute values that can be aggregated.
  • Counter: for delta values that increase monotonically.
  • UpDownCounter: for delta values that can increase and decrease.
number
NumberKind

Number Kind as defined by OpenTelemetry, defines the measure data type accepted by the Instrument. Supported values are:

  • Int64.
  • Float64.

InstrumentKind (string alias)

(Appears on: Instrument)

InstrumentKind as defined by OpenTelemetry.

JiraAuth

(Appears on: JiraTargetSpec)

JiraAuth contains Jira credentials.

Field Description
user
string

Jira username to connect to the instance as.

token
SecretValueFromSource

Jira API token bound to the user.

JiraTargetSpec

(Appears on: JiraTarget)

JiraTargetSpec defines the desired state of the event target.

Field Description
auth
JiraAuth

Authentication to interact with the Salesforce API.

url
string

URL for Jira service.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

KafkaTargetAuth

(Appears on: KafkaTargetSpec)

KafkaTargetAuth contains Authentication method used to interact with Kafka.

Field Description
kerberos
KafkaTargetKerberos
tls
KafkaTargetTLSAuth
saslEnable
bool

SASL Enable

tlsEnable
bool
(Optional)

TLS Enable

securityMechanism
string
(Optional)

SecurityMechanisms holds the assignment of the specific SASL mechanisms.

username
string
(Optional)

Username Kafka account User

password
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
(Optional)

Password Kafka account Password

KafkaTargetKerberos

(Appears on: KafkaTargetAuth)

KafkaTargetKerberos contains kerberos credentials.

Field Description
username
string
password
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
serviceName
string
configPath
string
keytabPath
string
config
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
keytab
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
realm
string

KafkaTargetSpec

(Appears on: KafkaTarget)

KafkaTargetSpec defines the desired state of the event target.

Field Description
topic
string

Topic where messages are produced.

topicReplicationFactor
int16
(Optional)

TopicReplicationFactor is the number of replicas for the topic.

topicPartitions
int32
(Optional)

TopicPartitions is the number of partitions for the topic.

bootstrapServers
[]string

BootstrapServers holds the name of the Kafka Bootstrap server.

auth
KafkaTargetAuth
(Optional)

Auth contains Authentication method used to interact with Kafka.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Kafka. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

KafkaTargetTLSAuth

(Appears on: KafkaTargetAuth)

KafkaTargetTLSAuth contains kerberos credentials.

Field Description
ca
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientCert
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientKey
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
skipVerify
bool

Keystore

(Appears on: TLSSpec)

Keystore represents Key Database components.

Field Description
keyDatabase
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
passwordStash
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

LogzMetricsConnection

(Appears on: LogzMetricsTargetSpec)

LogzMetricsConnection contains the information to connect to a Logz tenant to push metrics.

Field Description
token
SecretValueFromSource

Token for connecting to Logz metrics listener.

listenerURL
string

ListenerURL for pushing metrics.

LogzMetricsTargetSpec

(Appears on: LogzMetricsTarget)

LogzMetricsTargetSpec defines the desired state of the event target.

Field Description
connection
LogzMetricsConnection

Connection information for LogzMetrics.

instruments
[]Instrument

Instruments configured for pushing metrics. It is mandatory that all metrics pushed by using this target are pre-registered using this list.

eventOptions
EventOptions
(Optional)

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

LogzTargetSpec

(Appears on: LogzTarget)

LogzTargetSpec defines the desired state of the event target.

Field Description
shippingToken
SecretValueFromSource

ShippingToken defines the API token.

logsListenerURL
string

LogsListenerURL Defines the Log listener URL

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

MQReplyOptions

(Appears on: IBMMQTargetSpec)

Field Description
queueManager
string
queueName
string

MongoDBTargetSpec

(Appears on: MongoDBTarget)

MongoDBTargetSpec defines the desired state of the event target.

Field Description
connectionString
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

ConnectionString defines the MongoDB connection string.

database
string

Database defines the MongoDB database.

collection
string

Collection defines the MongoDB collection.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

NumberKind (string alias)

(Appears on: Instrument)

NumberKind as defined by OpenTelemetry.

OracleFunctionSpecSpec

(Appears on: OracleTargetSpec)

OracleFunctionSpecSpec defines the desired state of the event target.

Field Description
function
string

(Members of function are embedded into this type.)

Oracle Cloud ID of the function to invoke.

OracleTargetSpec

(Appears on: OracleTarget)

OracleTargetSpec defines the desired state of the event target.

Field Description
oracleApiPrivateKey
SecretValueFromSource

Oracle User API private key.

oracleApiPrivateKeyPassphrase
SecretValueFromSource

Oracle User API private key passphrase.

oracleApiPrivateKeyFingerprint
SecretValueFromSource

Oracle User API cert fingerprint.

oracleTenancy
string

Oracle Tenancy OCID.

oracleUser
string

Oracle User OCID associated with the API key.

oracleRegion
string

Oracle Cloud Region.

function
OracleFunctionSpecSpec
adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

SalesforceAuth

(Appears on: SalesforceTargetSpec)

SalesforceAuth contains OAuth JWT information to interact with the Salesforce API. See: https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_jwt_flow.htm

Field Description
clientID
string

ClientID for the Salesforce connected app.

server
string

Server points to the authorization URL.

user
string

User configuring the connected app.

certKey
SecretValueFromSource

CertKey is the private key used to sign requests from the target.

SalesforceTargetSpec

(Appears on: SalesforceTarget)

SalesforceTargetSpec defines the desired state of the event target.

Field Description
auth
SalesforceAuth

Authentication information to interact with the Salesforce API.

apiVersion
string
(Optional)

APIVersion at Salesforce. If not set the latest version will be used.

eventOptions
EventOptions
(Optional)

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

SecretValueFromSource

(Appears on: Connection, DatadogTargetSpec, GoogleCloudFirestoreTargetSpec, GoogleCloudPubSubTargetSpec, GoogleCloudStorageTargetSpec, GoogleCloudWorkflowsTargetSpec, GoogleSheetTargetSpec, HTTPTargetSpec, JiraAuth, LogzMetricsConnection, LogzTargetSpec, OracleTargetSpec, SalesforceAuth, SendGridTargetSpec, SlackTargetSpec, TwilioTargetSpec, ZendeskTargetSpec)

SecretValueFromSource represents the source of a secret value

Field Description
secretKeyRef
Kubernetes core/v1.SecretKeySelector

The Secret key to select from.

SendGridTargetSpec

(Appears on: SendGridTarget)

SendGridTargetSpec defines the desired state of the event target.

Field Description
apiKey
SecretValueFromSource

APIKey for account

defaultFromEmail
string
(Optional)

DefaultFromEmail is a default email account to assign to the outgoing email’s.

defaultToEmail
string
(Optional)

DefaultToEmail is a default recipient email account to assign to the outgoing email’s.

defaultToName
string
(Optional)

DefaultToName is a default recipient name to assign to the outgoing email’s.

defaultFromName
string
(Optional)

DefaultFromName is a default sender name to assign to the outgoing email’s.

defaultMessage
string
(Optional)

DefaultMessage is a default message to assign to the outgoing email’s.

defaultSubject
string
(Optional)

DefaultSubject is a default subject to assign to the outgoing email’s.

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

SlackTargetSpec

(Appears on: SlackTarget)

SlackTargetSpec defines the desired state of the event target.

Field Description
token
SecretValueFromSource

Token for Slack App

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

SolaceTargetAuth

(Appears on: SolaceTargetSpec)

SolaceTargetAuth contains Authentication method used to interact with Solace.

Field Description
tls
SolaceTargetTLSAuth
(Optional)

TLS

saslEnable
bool
(Optional)

SASL Enable

tlsEnable
bool
(Optional)

TLS Enable

username
string
(Optional)

Username Solace

password
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
(Optional)

Password Solace

SolaceTargetSpec

(Appears on: SolaceTarget)

SolaceTargetSpec defines the desired state of the event target.

Field Description
url
string

URL

queueName
string

QueueName

auth
SolaceTargetAuth
(Optional)

Auth contains Authentication method used to interact with Solace.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Solace. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

SolaceTargetTLSAuth

(Appears on: SolaceTargetAuth)

SolaceTargetTLSAuth contains SSL credentials.

Field Description
ca
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientCert
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
clientKey
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField
skipVerify
bool

SplunkTargetSpec

(Appears on: SplunkTarget)

SplunkTargetSpec defines the desired state of the event target.

Field Description
endpoint
knative.dev/pkg/apis.URL

URL of the HTTP Event Collector (HEC). Only the scheme, hostname, and port (optionally) are evaluated, the URL path is trimmed if present. see https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector#Enable_HTTP_Event_Collector

token
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.ValueFromField

Token for authenticating requests against the HEC. see https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector#About_Event_Collector_tokens

index
string
(Optional)

Name of the index to send events to. When undefined, events are sent to the default index defined in the HEC token’s configuration.

skipTLSVerify
bool
(Optional)

Controls whether the Splunk client verifies the server’s certificate chain and host name when communicating over TLS.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

discardCloudEventContext
bool

Whether to omit CloudEvent context attributes in messages sent to Splunk. When this property is false (default), the entire CloudEvent payload is included. When this property is true, only the CloudEvent data is included.

TLSSpec

(Appears on: Credentials)

TLSSpec defines the desired state of the event target.

Field Description
cipher
string
clientAuthRequired
bool
certLabel
string
keyRepository
Keystore

TwilioTargetSpec

(Appears on: TwilioTarget)

TwilioTargetSpec defines the desired state of the event target.

Field Description
sid
SecretValueFromSource

Twilio account SID

token
SecretValueFromSource

Twilio account Token

defaultPhoneFrom
string
(Optional)

DefaultPhoneFrom is the purchased Twilio phone we are using

defaultPhoneTo
string
(Optional)

DefaultPhoneTo is the destination phone

eventOptions
EventOptions

EventOptions for targets

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.

ZendeskTargetSpec

(Appears on: ZendeskTarget)

ZendeskTargetSpec defines the desired state of the event target.

Field Description
token
SecretValueFromSource

Token contains the Zendesk account Token.

subdomain
string

Subdomain the Zendesk subdomain.

email
string

Email the registered Zendesk email account.

subject
string
(Optional)

Subject a static subject assignemnt for every ticket.

adapterOverrides
github.com/triggermesh/triggermesh/pkg/apis/common/v1alpha1.AdapterOverrides
(Optional)

Adapter spec overrides parameters.


Generated with gen-crd-api-reference-docs on git commit 4b0dfae3.