Documentation
¶
Index ¶
- type AWSKinesisConfig
- type AWSKinesisCredentials
- type AWSSQSConfig
- type AWSSQSCredentials
- type DeliveryAttempt
- func (o *DeliveryAttempt) GetDeliveredAt() *time.Time
- func (o *DeliveryAttempt) GetResponseBody() *string
- func (o *DeliveryAttempt) GetResponseHeaders() map[string]string
- func (o *DeliveryAttempt) GetResponseStatusCode() *int64
- func (o *DeliveryAttempt) GetStatus() *Status
- func (d DeliveryAttempt) MarshalJSON() ([]byte, error)
- func (d *DeliveryAttempt) UnmarshalJSON(data []byte) error
- type Destination
- func CreateDestinationAwsKinesis(awsKinesis DestinationAWSKinesis) Destination
- func CreateDestinationAwsSqs(awsSqs DestinationAWSSQS) Destination
- func CreateDestinationHookdeck(hookdeck DestinationHookdeck) Destination
- func CreateDestinationRabbitmq(rabbitmq DestinationRabbitMQ) Destination
- func CreateDestinationWebhook(webhook DestinationWebhook) Destination
- type DestinationAWSKinesis
- func (o *DestinationAWSKinesis) GetConfig() AWSKinesisConfig
- func (o *DestinationAWSKinesis) GetCreatedAt() time.Time
- func (o *DestinationAWSKinesis) GetCredentials() AWSKinesisCredentials
- func (o *DestinationAWSKinesis) GetDisabledAt() *time.Time
- func (o *DestinationAWSKinesis) GetID() string
- func (o *DestinationAWSKinesis) GetTarget() *string
- func (o *DestinationAWSKinesis) GetTargetURL() *string
- func (o *DestinationAWSKinesis) GetTopics() Topics
- func (o *DestinationAWSKinesis) GetType() DestinationAWSKinesisType
- func (d DestinationAWSKinesis) MarshalJSON() ([]byte, error)
- func (d *DestinationAWSKinesis) UnmarshalJSON(data []byte) error
- type DestinationAWSKinesisType
- type DestinationAWSSQS
- func (o *DestinationAWSSQS) GetConfig() AWSSQSConfig
- func (o *DestinationAWSSQS) GetCreatedAt() time.Time
- func (o *DestinationAWSSQS) GetCredentials() AWSSQSCredentials
- func (o *DestinationAWSSQS) GetDisabledAt() *time.Time
- func (o *DestinationAWSSQS) GetID() string
- func (o *DestinationAWSSQS) GetTarget() *string
- func (o *DestinationAWSSQS) GetTargetURL() *string
- func (o *DestinationAWSSQS) GetTopics() Topics
- func (o *DestinationAWSSQS) GetType() DestinationAWSSQSType
- func (d DestinationAWSSQS) MarshalJSON() ([]byte, error)
- func (d *DestinationAWSSQS) UnmarshalJSON(data []byte) error
- type DestinationAWSSQSType
- type DestinationCreate
- func CreateDestinationCreateAwsKinesis(awsKinesis DestinationCreateAWSKinesis) DestinationCreate
- func CreateDestinationCreateAwsSqs(awsSqs DestinationCreateAWSSQS) DestinationCreate
- func CreateDestinationCreateHookdeck(hookdeck DestinationCreateHookdeck) DestinationCreate
- func CreateDestinationCreateRabbitmq(rabbitmq DestinationCreateRabbitMQ) DestinationCreate
- func CreateDestinationCreateWebhook(webhook DestinationCreateWebhook) DestinationCreate
- type DestinationCreateAWSKinesis
- func (o *DestinationCreateAWSKinesis) GetConfig() AWSKinesisConfig
- func (o *DestinationCreateAWSKinesis) GetCredentials() AWSKinesisCredentials
- func (o *DestinationCreateAWSKinesis) GetID() *string
- func (o *DestinationCreateAWSKinesis) GetTopics() Topics
- func (o *DestinationCreateAWSKinesis) GetType() DestinationCreateAWSKinesisType
- type DestinationCreateAWSKinesisType
- type DestinationCreateAWSSQS
- func (o *DestinationCreateAWSSQS) GetConfig() AWSSQSConfig
- func (o *DestinationCreateAWSSQS) GetCredentials() AWSSQSCredentials
- func (o *DestinationCreateAWSSQS) GetID() *string
- func (o *DestinationCreateAWSSQS) GetTopics() Topics
- func (o *DestinationCreateAWSSQS) GetType() DestinationCreateAWSSQSType
- type DestinationCreateAWSSQSType
- type DestinationCreateHookdeck
- func (o *DestinationCreateHookdeck) GetConfig() any
- func (o *DestinationCreateHookdeck) GetCredentials() HookdeckCredentials
- func (o *DestinationCreateHookdeck) GetID() *string
- func (o *DestinationCreateHookdeck) GetTopics() Topics
- func (o *DestinationCreateHookdeck) GetType() DestinationCreateHookdeckType
- type DestinationCreateHookdeckType
- type DestinationCreateRabbitMQ
- func (o *DestinationCreateRabbitMQ) GetConfig() RabbitMQConfig
- func (o *DestinationCreateRabbitMQ) GetCredentials() RabbitMQCredentials
- func (o *DestinationCreateRabbitMQ) GetID() *string
- func (o *DestinationCreateRabbitMQ) GetTopics() Topics
- func (o *DestinationCreateRabbitMQ) GetType() DestinationCreateRabbitMQType
- type DestinationCreateRabbitMQType
- type DestinationCreateType
- type DestinationCreateWebhook
- func (o *DestinationCreateWebhook) GetConfig() WebhookConfig
- func (o *DestinationCreateWebhook) GetCredentials() *WebhookCredentials
- func (o *DestinationCreateWebhook) GetID() *string
- func (o *DestinationCreateWebhook) GetTopics() Topics
- func (o *DestinationCreateWebhook) GetType() DestinationCreateWebhookType
- type DestinationCreateWebhookType
- type DestinationHookdeck
- func (o *DestinationHookdeck) GetConfig() any
- func (o *DestinationHookdeck) GetCreatedAt() time.Time
- func (o *DestinationHookdeck) GetCredentials() HookdeckCredentials
- func (o *DestinationHookdeck) GetDisabledAt() *time.Time
- func (o *DestinationHookdeck) GetID() string
- func (o *DestinationHookdeck) GetTarget() *string
- func (o *DestinationHookdeck) GetTargetURL() *string
- func (o *DestinationHookdeck) GetTopics() Topics
- func (o *DestinationHookdeck) GetType() DestinationHookdeckType
- func (d DestinationHookdeck) MarshalJSON() ([]byte, error)
- func (d *DestinationHookdeck) UnmarshalJSON(data []byte) error
- type DestinationHookdeckType
- type DestinationRabbitMQ
- func (o *DestinationRabbitMQ) GetConfig() RabbitMQConfig
- func (o *DestinationRabbitMQ) GetCreatedAt() time.Time
- func (o *DestinationRabbitMQ) GetCredentials() RabbitMQCredentials
- func (o *DestinationRabbitMQ) GetDisabledAt() *time.Time
- func (o *DestinationRabbitMQ) GetID() string
- func (o *DestinationRabbitMQ) GetTarget() *string
- func (o *DestinationRabbitMQ) GetTargetURL() *string
- func (o *DestinationRabbitMQ) GetTopics() Topics
- func (o *DestinationRabbitMQ) GetType() DestinationRabbitMQType
- func (d DestinationRabbitMQ) MarshalJSON() ([]byte, error)
- func (d *DestinationRabbitMQ) UnmarshalJSON(data []byte) error
- type DestinationRabbitMQType
- type DestinationSchemaField
- func (o *DestinationSchemaField) GetDefault() *string
- func (o *DestinationSchemaField) GetDescription() *string
- func (o *DestinationSchemaField) GetLabel() *string
- func (o *DestinationSchemaField) GetMaxlength() *int64
- func (o *DestinationSchemaField) GetMinlength() *int64
- func (o *DestinationSchemaField) GetPattern() *string
- func (o *DestinationSchemaField) GetRequired() bool
- func (o *DestinationSchemaField) GetSensitive() *bool
- func (o *DestinationSchemaField) GetType() DestinationSchemaFieldType
- type DestinationSchemaFieldType
- type DestinationType
- type DestinationTypeSchema
- func (o *DestinationTypeSchema) GetConfigFields() []DestinationSchemaField
- func (o *DestinationTypeSchema) GetCredentialFields() []DestinationSchemaField
- func (o *DestinationTypeSchema) GetDescription() *string
- func (o *DestinationTypeSchema) GetIcon() *string
- func (o *DestinationTypeSchema) GetInstructions() *string
- func (o *DestinationTypeSchema) GetLabel() *string
- func (o *DestinationTypeSchema) GetRemoteSetupURL() *string
- func (o *DestinationTypeSchema) GetType() *string
- type DestinationUpdate
- func CreateDestinationUpdateDestinationUpdateAWSKinesis(destinationUpdateAWSKinesis DestinationUpdateAWSKinesis) DestinationUpdate
- func CreateDestinationUpdateDestinationUpdateAWSSQS(destinationUpdateAWSSQS DestinationUpdateAWSSQS) DestinationUpdate
- func CreateDestinationUpdateDestinationUpdateHookdeck(destinationUpdateHookdeck DestinationUpdateHookdeck) DestinationUpdate
- func CreateDestinationUpdateDestinationUpdateRabbitMQ(destinationUpdateRabbitMQ DestinationUpdateRabbitMQ) DestinationUpdate
- func CreateDestinationUpdateDestinationUpdateWebhook(destinationUpdateWebhook DestinationUpdateWebhook) DestinationUpdate
- type DestinationUpdateAWSKinesis
- type DestinationUpdateAWSSQS
- type DestinationUpdateHookdeck
- type DestinationUpdateRabbitMQ
- type DestinationUpdateType
- type DestinationUpdateWebhook
- type DestinationWebhook
- func (o *DestinationWebhook) GetConfig() WebhookConfig
- func (o *DestinationWebhook) GetCreatedAt() time.Time
- func (o *DestinationWebhook) GetCredentials() WebhookCredentials
- func (o *DestinationWebhook) GetDisabledAt() *time.Time
- func (o *DestinationWebhook) GetID() string
- func (o *DestinationWebhook) GetTarget() *string
- func (o *DestinationWebhook) GetTargetURL() *string
- func (o *DestinationWebhook) GetTopics() Topics
- func (o *DestinationWebhook) GetType() DestinationWebhookType
- func (d DestinationWebhook) MarshalJSON() ([]byte, error)
- func (d *DestinationWebhook) UnmarshalJSON(data []byte) error
- type DestinationWebhookType
- type Event
- func (o *Event) GetData() map[string]any
- func (o *Event) GetDestinationID() *string
- func (o *Event) GetID() *string
- func (o *Event) GetMetadata() map[string]string
- func (o *Event) GetSuccessfulAt() *time.Time
- func (o *Event) GetTime() *time.Time
- func (o *Event) GetTopic() *string
- func (e Event) MarshalJSON() ([]byte, error)
- func (e *Event) UnmarshalJSON(data []byte) error
- type HTTPMetadata
- type HookdeckCredentials
- type PortalRedirect
- type PublishRequest
- func (o *PublishRequest) GetData() map[string]any
- func (o *PublishRequest) GetDestinationID() *string
- func (o *PublishRequest) GetEligibleForRetry() *bool
- func (o *PublishRequest) GetID() *string
- func (o *PublishRequest) GetMetadata() map[string]string
- func (o *PublishRequest) GetTenantID() *string
- func (o *PublishRequest) GetTopic() *string
- type PublishResponse
- type RabbitMQConfig
- type RabbitMQCredentials
- type Security
- type Status
- type SuccessResponse
- type TLS
- type Tenant
- type TenantToken
- type Topics
- type TopicsEnum
- type TopicsType
- type WebhookConfig
- type WebhookCredentials
- type WebhookCredentialsUpdate
- func (o *WebhookCredentialsUpdate) GetPreviousSecret() *string
- func (o *WebhookCredentialsUpdate) GetPreviousSecretInvalidAt() *time.Time
- func (o *WebhookCredentialsUpdate) GetRotateSecret() *bool
- func (o *WebhookCredentialsUpdate) GetSecret() *string
- func (w WebhookCredentialsUpdate) MarshalJSON() ([]byte, error)
- func (w *WebhookCredentialsUpdate) UnmarshalJSON(data []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AWSKinesisConfig ¶
type AWSKinesisConfig struct { // The name of the AWS Kinesis stream. StreamName string `json:"stream_name"` // The AWS region where the Kinesis stream is located. Region string `json:"region"` // Optional. Custom AWS endpoint URL (e.g., for LocalStack or VPC endpoints). Endpoint *string `json:"endpoint,omitempty"` // Optional. JMESPath template to extract the partition key from the event payload (e.g., `metadata."event-id"`). Defaults to event ID. PartitionKeyTemplate *string `json:"partition_key_template,omitempty"` }
func (*AWSKinesisConfig) GetEndpoint ¶
func (o *AWSKinesisConfig) GetEndpoint() *string
func (*AWSKinesisConfig) GetPartitionKeyTemplate ¶
func (o *AWSKinesisConfig) GetPartitionKeyTemplate() *string
func (*AWSKinesisConfig) GetRegion ¶
func (o *AWSKinesisConfig) GetRegion() string
func (*AWSKinesisConfig) GetStreamName ¶
func (o *AWSKinesisConfig) GetStreamName() string
type AWSKinesisCredentials ¶
type AWSKinesisCredentials struct { // AWS Access Key ID. Key string `json:"key"` // AWS Secret Access Key. Secret string `json:"secret"` // Optional AWS Session Token (for temporary credentials). Session *string `json:"session,omitempty"` }
func (*AWSKinesisCredentials) GetKey ¶
func (o *AWSKinesisCredentials) GetKey() string
func (*AWSKinesisCredentials) GetSecret ¶
func (o *AWSKinesisCredentials) GetSecret() string
func (*AWSKinesisCredentials) GetSession ¶
func (o *AWSKinesisCredentials) GetSession() *string
type AWSSQSConfig ¶
type AWSSQSConfig struct { // Optional. Custom AWS endpoint URL (e.g., for LocalStack or specific regions). Endpoint *string `json:"endpoint,omitempty"` // The URL of the SQS queue. QueueURL string `json:"queue_url"` }
func (*AWSSQSConfig) GetEndpoint ¶
func (o *AWSSQSConfig) GetEndpoint() *string
func (*AWSSQSConfig) GetQueueURL ¶
func (o *AWSSQSConfig) GetQueueURL() string
type AWSSQSCredentials ¶
type AWSSQSCredentials struct { // AWS Access Key ID. Key string `json:"key"` // AWS Secret Access Key. Secret string `json:"secret"` // Optional AWS Session Token (for temporary credentials). Session *string `json:"session,omitempty"` }
func (*AWSSQSCredentials) GetKey ¶
func (o *AWSSQSCredentials) GetKey() string
func (*AWSSQSCredentials) GetSecret ¶
func (o *AWSSQSCredentials) GetSecret() string
func (*AWSSQSCredentials) GetSession ¶
func (o *AWSSQSCredentials) GetSession() *string
type DeliveryAttempt ¶
type DeliveryAttempt struct { DeliveredAt *time.Time `json:"delivered_at,omitempty"` Status *Status `json:"status,omitempty"` ResponseStatusCode *int64 `json:"response_status_code,omitempty"` ResponseBody *string `json:"response_body,omitempty"` ResponseHeaders map[string]string `json:"response_headers,omitempty"` }
func (*DeliveryAttempt) GetDeliveredAt ¶
func (o *DeliveryAttempt) GetDeliveredAt() *time.Time
func (*DeliveryAttempt) GetResponseBody ¶
func (o *DeliveryAttempt) GetResponseBody() *string
func (*DeliveryAttempt) GetResponseHeaders ¶
func (o *DeliveryAttempt) GetResponseHeaders() map[string]string
func (*DeliveryAttempt) GetResponseStatusCode ¶
func (o *DeliveryAttempt) GetResponseStatusCode() *int64
func (*DeliveryAttempt) GetStatus ¶
func (o *DeliveryAttempt) GetStatus() *Status
func (DeliveryAttempt) MarshalJSON ¶
func (d DeliveryAttempt) MarshalJSON() ([]byte, error)
func (*DeliveryAttempt) UnmarshalJSON ¶
func (d *DeliveryAttempt) UnmarshalJSON(data []byte) error
type Destination ¶
type Destination struct { DestinationWebhook *DestinationWebhook `queryParam:"inline"` DestinationAWSSQS *DestinationAWSSQS `queryParam:"inline"` DestinationRabbitMQ *DestinationRabbitMQ `queryParam:"inline"` DestinationHookdeck *DestinationHookdeck `queryParam:"inline"` DestinationAWSKinesis *DestinationAWSKinesis `queryParam:"inline"` Type DestinationType }
func CreateDestinationAwsKinesis ¶
func CreateDestinationAwsKinesis(awsKinesis DestinationAWSKinesis) Destination
func CreateDestinationAwsSqs ¶
func CreateDestinationAwsSqs(awsSqs DestinationAWSSQS) Destination
func CreateDestinationHookdeck ¶
func CreateDestinationHookdeck(hookdeck DestinationHookdeck) Destination
func CreateDestinationRabbitmq ¶
func CreateDestinationRabbitmq(rabbitmq DestinationRabbitMQ) Destination
func CreateDestinationWebhook ¶
func CreateDestinationWebhook(webhook DestinationWebhook) Destination
func (Destination) MarshalJSON ¶
func (u Destination) MarshalJSON() ([]byte, error)
func (*Destination) UnmarshalJSON ¶
func (u *Destination) UnmarshalJSON(data []byte) error
type DestinationAWSKinesis ¶
type DestinationAWSKinesis struct { // Control plane generated ID or user provided ID for the destination. ID string `json:"id"` // Type of the destination. Type DestinationAWSKinesisType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` // ISO Date when the destination was disabled, or null if enabled. DisabledAt *time.Time `json:"disabled_at"` // ISO Date when the destination was created. CreatedAt time.Time `json:"created_at"` Config AWSKinesisConfig `json:"config"` Credentials AWSKinesisCredentials `json:"credentials"` // A human-readable representation of the destination target (Kinesis stream name). Read-only. Target *string `json:"target,omitempty"` // A URL link to the destination target (AWS Console link to the stream). Read-only. TargetURL *string `json:"target_url,omitempty"` }
func (*DestinationAWSKinesis) GetConfig ¶
func (o *DestinationAWSKinesis) GetConfig() AWSKinesisConfig
func (*DestinationAWSKinesis) GetCreatedAt ¶
func (o *DestinationAWSKinesis) GetCreatedAt() time.Time
func (*DestinationAWSKinesis) GetCredentials ¶
func (o *DestinationAWSKinesis) GetCredentials() AWSKinesisCredentials
func (*DestinationAWSKinesis) GetDisabledAt ¶
func (o *DestinationAWSKinesis) GetDisabledAt() *time.Time
func (*DestinationAWSKinesis) GetID ¶
func (o *DestinationAWSKinesis) GetID() string
func (*DestinationAWSKinesis) GetTarget ¶
func (o *DestinationAWSKinesis) GetTarget() *string
func (*DestinationAWSKinesis) GetTargetURL ¶
func (o *DestinationAWSKinesis) GetTargetURL() *string
func (*DestinationAWSKinesis) GetTopics ¶
func (o *DestinationAWSKinesis) GetTopics() Topics
func (*DestinationAWSKinesis) GetType ¶
func (o *DestinationAWSKinesis) GetType() DestinationAWSKinesisType
func (DestinationAWSKinesis) MarshalJSON ¶
func (d DestinationAWSKinesis) MarshalJSON() ([]byte, error)
func (*DestinationAWSKinesis) UnmarshalJSON ¶
func (d *DestinationAWSKinesis) UnmarshalJSON(data []byte) error
type DestinationAWSKinesisType ¶
type DestinationAWSKinesisType string
DestinationAWSKinesisType - Type of the destination.
const (
DestinationAWSKinesisTypeAwsKinesis DestinationAWSKinesisType = "aws_kinesis"
)
func (DestinationAWSKinesisType) ToPointer ¶
func (e DestinationAWSKinesisType) ToPointer() *DestinationAWSKinesisType
func (*DestinationAWSKinesisType) UnmarshalJSON ¶
func (e *DestinationAWSKinesisType) UnmarshalJSON(data []byte) error
type DestinationAWSSQS ¶
type DestinationAWSSQS struct { // Control plane generated ID or user provided ID for the destination. ID string `json:"id"` // Type of the destination. Type DestinationAWSSQSType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` // ISO Date when the destination was disabled, or null if enabled. DisabledAt *time.Time `json:"disabled_at"` // ISO Date when the destination was created. CreatedAt time.Time `json:"created_at"` Config AWSSQSConfig `json:"config"` Credentials AWSSQSCredentials `json:"credentials"` // A human-readable representation of the destination target (SQS queue name). Read-only. Target *string `json:"target,omitempty"` // A URL link to the destination target (AWS Console link to the queue). Read-only. TargetURL *string `json:"target_url,omitempty"` }
func (*DestinationAWSSQS) GetConfig ¶
func (o *DestinationAWSSQS) GetConfig() AWSSQSConfig
func (*DestinationAWSSQS) GetCreatedAt ¶
func (o *DestinationAWSSQS) GetCreatedAt() time.Time
func (*DestinationAWSSQS) GetCredentials ¶
func (o *DestinationAWSSQS) GetCredentials() AWSSQSCredentials
func (*DestinationAWSSQS) GetDisabledAt ¶
func (o *DestinationAWSSQS) GetDisabledAt() *time.Time
func (*DestinationAWSSQS) GetID ¶
func (o *DestinationAWSSQS) GetID() string
func (*DestinationAWSSQS) GetTarget ¶
func (o *DestinationAWSSQS) GetTarget() *string
func (*DestinationAWSSQS) GetTargetURL ¶
func (o *DestinationAWSSQS) GetTargetURL() *string
func (*DestinationAWSSQS) GetTopics ¶
func (o *DestinationAWSSQS) GetTopics() Topics
func (*DestinationAWSSQS) GetType ¶
func (o *DestinationAWSSQS) GetType() DestinationAWSSQSType
func (DestinationAWSSQS) MarshalJSON ¶
func (d DestinationAWSSQS) MarshalJSON() ([]byte, error)
func (*DestinationAWSSQS) UnmarshalJSON ¶
func (d *DestinationAWSSQS) UnmarshalJSON(data []byte) error
type DestinationAWSSQSType ¶
type DestinationAWSSQSType string
DestinationAWSSQSType - Type of the destination.
const (
DestinationAWSSQSTypeAwsSqs DestinationAWSSQSType = "aws_sqs"
)
func (DestinationAWSSQSType) ToPointer ¶
func (e DestinationAWSSQSType) ToPointer() *DestinationAWSSQSType
func (*DestinationAWSSQSType) UnmarshalJSON ¶
func (e *DestinationAWSSQSType) UnmarshalJSON(data []byte) error
type DestinationCreate ¶
type DestinationCreate struct { DestinationCreateWebhook *DestinationCreateWebhook `queryParam:"inline"` DestinationCreateAWSSQS *DestinationCreateAWSSQS `queryParam:"inline"` DestinationCreateRabbitMQ *DestinationCreateRabbitMQ `queryParam:"inline"` DestinationCreateHookdeck *DestinationCreateHookdeck `queryParam:"inline"` DestinationCreateAWSKinesis *DestinationCreateAWSKinesis `queryParam:"inline"` Type DestinationCreateType }
func CreateDestinationCreateAwsKinesis ¶
func CreateDestinationCreateAwsKinesis(awsKinesis DestinationCreateAWSKinesis) DestinationCreate
func CreateDestinationCreateAwsSqs ¶
func CreateDestinationCreateAwsSqs(awsSqs DestinationCreateAWSSQS) DestinationCreate
func CreateDestinationCreateHookdeck ¶
func CreateDestinationCreateHookdeck(hookdeck DestinationCreateHookdeck) DestinationCreate
func CreateDestinationCreateRabbitmq ¶
func CreateDestinationCreateRabbitmq(rabbitmq DestinationCreateRabbitMQ) DestinationCreate
func CreateDestinationCreateWebhook ¶
func CreateDestinationCreateWebhook(webhook DestinationCreateWebhook) DestinationCreate
func (DestinationCreate) MarshalJSON ¶
func (u DestinationCreate) MarshalJSON() ([]byte, error)
func (*DestinationCreate) UnmarshalJSON ¶
func (u *DestinationCreate) UnmarshalJSON(data []byte) error
type DestinationCreateAWSKinesis ¶
type DestinationCreateAWSKinesis struct { // Optional user-provided ID. A UUID will be generated if empty. ID *string `json:"id,omitempty"` // Type of the destination. Must be 'aws_kinesis'. Type DestinationCreateAWSKinesisType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` Config AWSKinesisConfig `json:"config"` Credentials AWSKinesisCredentials `json:"credentials"` }
func (*DestinationCreateAWSKinesis) GetConfig ¶
func (o *DestinationCreateAWSKinesis) GetConfig() AWSKinesisConfig
func (*DestinationCreateAWSKinesis) GetCredentials ¶
func (o *DestinationCreateAWSKinesis) GetCredentials() AWSKinesisCredentials
func (*DestinationCreateAWSKinesis) GetID ¶
func (o *DestinationCreateAWSKinesis) GetID() *string
func (*DestinationCreateAWSKinesis) GetTopics ¶
func (o *DestinationCreateAWSKinesis) GetTopics() Topics
func (*DestinationCreateAWSKinesis) GetType ¶
func (o *DestinationCreateAWSKinesis) GetType() DestinationCreateAWSKinesisType
type DestinationCreateAWSKinesisType ¶
type DestinationCreateAWSKinesisType string
DestinationCreateAWSKinesisType - Type of the destination. Must be 'aws_kinesis'.
const (
DestinationCreateAWSKinesisTypeAwsKinesis DestinationCreateAWSKinesisType = "aws_kinesis"
)
func (DestinationCreateAWSKinesisType) ToPointer ¶
func (e DestinationCreateAWSKinesisType) ToPointer() *DestinationCreateAWSKinesisType
func (*DestinationCreateAWSKinesisType) UnmarshalJSON ¶
func (e *DestinationCreateAWSKinesisType) UnmarshalJSON(data []byte) error
type DestinationCreateAWSSQS ¶
type DestinationCreateAWSSQS struct { // Optional user-provided ID. A UUID will be generated if empty. ID *string `json:"id,omitempty"` // Type of the destination. Must be 'aws_sqs'. Type DestinationCreateAWSSQSType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` Config AWSSQSConfig `json:"config"` Credentials AWSSQSCredentials `json:"credentials"` }
func (*DestinationCreateAWSSQS) GetConfig ¶
func (o *DestinationCreateAWSSQS) GetConfig() AWSSQSConfig
func (*DestinationCreateAWSSQS) GetCredentials ¶
func (o *DestinationCreateAWSSQS) GetCredentials() AWSSQSCredentials
func (*DestinationCreateAWSSQS) GetID ¶
func (o *DestinationCreateAWSSQS) GetID() *string
func (*DestinationCreateAWSSQS) GetTopics ¶
func (o *DestinationCreateAWSSQS) GetTopics() Topics
func (*DestinationCreateAWSSQS) GetType ¶
func (o *DestinationCreateAWSSQS) GetType() DestinationCreateAWSSQSType
type DestinationCreateAWSSQSType ¶
type DestinationCreateAWSSQSType string
DestinationCreateAWSSQSType - Type of the destination. Must be 'aws_sqs'.
const (
DestinationCreateAWSSQSTypeAwsSqs DestinationCreateAWSSQSType = "aws_sqs"
)
func (DestinationCreateAWSSQSType) ToPointer ¶
func (e DestinationCreateAWSSQSType) ToPointer() *DestinationCreateAWSSQSType
func (*DestinationCreateAWSSQSType) UnmarshalJSON ¶
func (e *DestinationCreateAWSSQSType) UnmarshalJSON(data []byte) error
type DestinationCreateHookdeck ¶
type DestinationCreateHookdeck struct { // Optional user-provided ID. A UUID will be generated if empty. ID *string `json:"id,omitempty"` // Type of the destination. Must be 'hookdeck'. Type DestinationCreateHookdeckType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` Config any `json:"config,omitempty"` Credentials HookdeckCredentials `json:"credentials"` }
func (*DestinationCreateHookdeck) GetConfig ¶
func (o *DestinationCreateHookdeck) GetConfig() any
func (*DestinationCreateHookdeck) GetCredentials ¶
func (o *DestinationCreateHookdeck) GetCredentials() HookdeckCredentials
func (*DestinationCreateHookdeck) GetID ¶
func (o *DestinationCreateHookdeck) GetID() *string
func (*DestinationCreateHookdeck) GetTopics ¶
func (o *DestinationCreateHookdeck) GetTopics() Topics
func (*DestinationCreateHookdeck) GetType ¶
func (o *DestinationCreateHookdeck) GetType() DestinationCreateHookdeckType
type DestinationCreateHookdeckType ¶
type DestinationCreateHookdeckType string
DestinationCreateHookdeckType - Type of the destination. Must be 'hookdeck'.
const (
DestinationCreateHookdeckTypeHookdeck DestinationCreateHookdeckType = "hookdeck"
)
func (DestinationCreateHookdeckType) ToPointer ¶
func (e DestinationCreateHookdeckType) ToPointer() *DestinationCreateHookdeckType
func (*DestinationCreateHookdeckType) UnmarshalJSON ¶
func (e *DestinationCreateHookdeckType) UnmarshalJSON(data []byte) error
type DestinationCreateRabbitMQ ¶
type DestinationCreateRabbitMQ struct { // Optional user-provided ID. A UUID will be generated if empty. ID *string `json:"id,omitempty"` // Type of the destination. Must be 'rabbitmq'. Type DestinationCreateRabbitMQType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` Config RabbitMQConfig `json:"config"` Credentials RabbitMQCredentials `json:"credentials"` }
func (*DestinationCreateRabbitMQ) GetConfig ¶
func (o *DestinationCreateRabbitMQ) GetConfig() RabbitMQConfig
func (*DestinationCreateRabbitMQ) GetCredentials ¶
func (o *DestinationCreateRabbitMQ) GetCredentials() RabbitMQCredentials
func (*DestinationCreateRabbitMQ) GetID ¶
func (o *DestinationCreateRabbitMQ) GetID() *string
func (*DestinationCreateRabbitMQ) GetTopics ¶
func (o *DestinationCreateRabbitMQ) GetTopics() Topics
func (*DestinationCreateRabbitMQ) GetType ¶
func (o *DestinationCreateRabbitMQ) GetType() DestinationCreateRabbitMQType
type DestinationCreateRabbitMQType ¶
type DestinationCreateRabbitMQType string
DestinationCreateRabbitMQType - Type of the destination. Must be 'rabbitmq'.
const (
DestinationCreateRabbitMQTypeRabbitmq DestinationCreateRabbitMQType = "rabbitmq"
)
func (DestinationCreateRabbitMQType) ToPointer ¶
func (e DestinationCreateRabbitMQType) ToPointer() *DestinationCreateRabbitMQType
func (*DestinationCreateRabbitMQType) UnmarshalJSON ¶
func (e *DestinationCreateRabbitMQType) UnmarshalJSON(data []byte) error
type DestinationCreateType ¶
type DestinationCreateType string
const ( DestinationCreateTypeWebhook DestinationCreateType = "webhook" DestinationCreateTypeAwsSqs DestinationCreateType = "aws_sqs" DestinationCreateTypeRabbitmq DestinationCreateType = "rabbitmq" DestinationCreateTypeHookdeck DestinationCreateType = "hookdeck" DestinationCreateTypeAwsKinesis DestinationCreateType = "aws_kinesis" )
type DestinationCreateWebhook ¶
type DestinationCreateWebhook struct { // Optional user-provided ID. A UUID will be generated if empty. ID *string `json:"id,omitempty"` // Type of the destination. Must be 'webhook'. Type DestinationCreateWebhookType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` Config WebhookConfig `json:"config"` Credentials *WebhookCredentials `json:"credentials,omitempty"` }
func (*DestinationCreateWebhook) GetConfig ¶
func (o *DestinationCreateWebhook) GetConfig() WebhookConfig
func (*DestinationCreateWebhook) GetCredentials ¶
func (o *DestinationCreateWebhook) GetCredentials() *WebhookCredentials
func (*DestinationCreateWebhook) GetID ¶
func (o *DestinationCreateWebhook) GetID() *string
func (*DestinationCreateWebhook) GetTopics ¶
func (o *DestinationCreateWebhook) GetTopics() Topics
func (*DestinationCreateWebhook) GetType ¶
func (o *DestinationCreateWebhook) GetType() DestinationCreateWebhookType
type DestinationCreateWebhookType ¶
type DestinationCreateWebhookType string
DestinationCreateWebhookType - Type of the destination. Must be 'webhook'.
const (
DestinationCreateWebhookTypeWebhook DestinationCreateWebhookType = "webhook"
)
func (DestinationCreateWebhookType) ToPointer ¶
func (e DestinationCreateWebhookType) ToPointer() *DestinationCreateWebhookType
func (*DestinationCreateWebhookType) UnmarshalJSON ¶
func (e *DestinationCreateWebhookType) UnmarshalJSON(data []byte) error
type DestinationHookdeck ¶
type DestinationHookdeck struct { // Control plane generated ID or user provided ID for the destination. ID string `json:"id"` // Type of the destination. Type DestinationHookdeckType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` // ISO Date when the destination was disabled, or null if enabled. DisabledAt *time.Time `json:"disabled_at"` // ISO Date when the destination was created. CreatedAt time.Time `json:"created_at"` Config any `json:"config,omitempty"` Credentials HookdeckCredentials `json:"credentials"` // A human-readable representation of the destination target (Hookdeck). Read-only. Target *string `json:"target,omitempty"` // A URL link to the destination target (e.g., Hookdeck dashboard). Read-only. TargetURL *string `json:"target_url,omitempty"` }
func (*DestinationHookdeck) GetConfig ¶
func (o *DestinationHookdeck) GetConfig() any
func (*DestinationHookdeck) GetCreatedAt ¶
func (o *DestinationHookdeck) GetCreatedAt() time.Time
func (*DestinationHookdeck) GetCredentials ¶
func (o *DestinationHookdeck) GetCredentials() HookdeckCredentials
func (*DestinationHookdeck) GetDisabledAt ¶
func (o *DestinationHookdeck) GetDisabledAt() *time.Time
func (*DestinationHookdeck) GetID ¶
func (o *DestinationHookdeck) GetID() string
func (*DestinationHookdeck) GetTarget ¶
func (o *DestinationHookdeck) GetTarget() *string
func (*DestinationHookdeck) GetTargetURL ¶
func (o *DestinationHookdeck) GetTargetURL() *string
func (*DestinationHookdeck) GetTopics ¶
func (o *DestinationHookdeck) GetTopics() Topics
func (*DestinationHookdeck) GetType ¶
func (o *DestinationHookdeck) GetType() DestinationHookdeckType
func (DestinationHookdeck) MarshalJSON ¶
func (d DestinationHookdeck) MarshalJSON() ([]byte, error)
func (*DestinationHookdeck) UnmarshalJSON ¶
func (d *DestinationHookdeck) UnmarshalJSON(data []byte) error
type DestinationHookdeckType ¶
type DestinationHookdeckType string
DestinationHookdeckType - Type of the destination.
const (
DestinationHookdeckTypeHookdeck DestinationHookdeckType = "hookdeck"
)
func (DestinationHookdeckType) ToPointer ¶
func (e DestinationHookdeckType) ToPointer() *DestinationHookdeckType
func (*DestinationHookdeckType) UnmarshalJSON ¶
func (e *DestinationHookdeckType) UnmarshalJSON(data []byte) error
type DestinationRabbitMQ ¶
type DestinationRabbitMQ struct { // Control plane generated ID or user provided ID for the destination. ID string `json:"id"` // Type of the destination. Type DestinationRabbitMQType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` // ISO Date when the destination was disabled, or null if enabled. DisabledAt *time.Time `json:"disabled_at"` // ISO Date when the destination was created. CreatedAt time.Time `json:"created_at"` Config RabbitMQConfig `json:"config"` Credentials RabbitMQCredentials `json:"credentials"` // A human-readable representation of the destination target (RabbitMQ exchange). Read-only. Target *string `json:"target,omitempty"` // A URL link to the destination target (not applicable for RabbitMQ exchange). Read-only. TargetURL *string `json:"target_url,omitempty"` }
func (*DestinationRabbitMQ) GetConfig ¶
func (o *DestinationRabbitMQ) GetConfig() RabbitMQConfig
func (*DestinationRabbitMQ) GetCreatedAt ¶
func (o *DestinationRabbitMQ) GetCreatedAt() time.Time
func (*DestinationRabbitMQ) GetCredentials ¶
func (o *DestinationRabbitMQ) GetCredentials() RabbitMQCredentials
func (*DestinationRabbitMQ) GetDisabledAt ¶
func (o *DestinationRabbitMQ) GetDisabledAt() *time.Time
func (*DestinationRabbitMQ) GetID ¶
func (o *DestinationRabbitMQ) GetID() string
func (*DestinationRabbitMQ) GetTarget ¶
func (o *DestinationRabbitMQ) GetTarget() *string
func (*DestinationRabbitMQ) GetTargetURL ¶
func (o *DestinationRabbitMQ) GetTargetURL() *string
func (*DestinationRabbitMQ) GetTopics ¶
func (o *DestinationRabbitMQ) GetTopics() Topics
func (*DestinationRabbitMQ) GetType ¶
func (o *DestinationRabbitMQ) GetType() DestinationRabbitMQType
func (DestinationRabbitMQ) MarshalJSON ¶
func (d DestinationRabbitMQ) MarshalJSON() ([]byte, error)
func (*DestinationRabbitMQ) UnmarshalJSON ¶
func (d *DestinationRabbitMQ) UnmarshalJSON(data []byte) error
type DestinationRabbitMQType ¶
type DestinationRabbitMQType string
DestinationRabbitMQType - Type of the destination.
const (
DestinationRabbitMQTypeRabbitmq DestinationRabbitMQType = "rabbitmq"
)
func (DestinationRabbitMQType) ToPointer ¶
func (e DestinationRabbitMQType) ToPointer() *DestinationRabbitMQType
func (*DestinationRabbitMQType) UnmarshalJSON ¶
func (e *DestinationRabbitMQType) UnmarshalJSON(data []byte) error
type DestinationSchemaField ¶
type DestinationSchemaField struct { Type DestinationSchemaFieldType `json:"type"` Label *string `json:"label,omitempty"` Description *string `json:"description,omitempty"` Required bool `json:"required"` // Indicates if the field contains sensitive information. Sensitive *bool `json:"sensitive,omitempty"` // Default value for the field. Default *string `json:"default,omitempty"` // Minimum length for a text input. Minlength *int64 `json:"minlength,omitempty"` // Maximum length for a text input. Maxlength *int64 `json:"maxlength,omitempty"` // Regex pattern for validation (compatible with HTML5 pattern attribute). Pattern *string `json:"pattern,omitempty"` }
func (*DestinationSchemaField) GetDefault ¶
func (o *DestinationSchemaField) GetDefault() *string
func (*DestinationSchemaField) GetDescription ¶
func (o *DestinationSchemaField) GetDescription() *string
func (*DestinationSchemaField) GetLabel ¶
func (o *DestinationSchemaField) GetLabel() *string
func (*DestinationSchemaField) GetMaxlength ¶
func (o *DestinationSchemaField) GetMaxlength() *int64
func (*DestinationSchemaField) GetMinlength ¶
func (o *DestinationSchemaField) GetMinlength() *int64
func (*DestinationSchemaField) GetPattern ¶
func (o *DestinationSchemaField) GetPattern() *string
func (*DestinationSchemaField) GetRequired ¶
func (o *DestinationSchemaField) GetRequired() bool
func (*DestinationSchemaField) GetSensitive ¶
func (o *DestinationSchemaField) GetSensitive() *bool
func (*DestinationSchemaField) GetType ¶
func (o *DestinationSchemaField) GetType() DestinationSchemaFieldType
type DestinationSchemaFieldType ¶
type DestinationSchemaFieldType string
const ( DestinationSchemaFieldTypeText DestinationSchemaFieldType = "text" DestinationSchemaFieldTypeCheckbox DestinationSchemaFieldType = "checkbox" )
func (DestinationSchemaFieldType) ToPointer ¶
func (e DestinationSchemaFieldType) ToPointer() *DestinationSchemaFieldType
func (*DestinationSchemaFieldType) UnmarshalJSON ¶
func (e *DestinationSchemaFieldType) UnmarshalJSON(data []byte) error
type DestinationType ¶
type DestinationType string
const ( DestinationTypeWebhook DestinationType = "webhook" DestinationTypeAwsSqs DestinationType = "aws_sqs" DestinationTypeRabbitmq DestinationType = "rabbitmq" DestinationTypeHookdeck DestinationType = "hookdeck" DestinationTypeAwsKinesis DestinationType = "aws_kinesis" )
type DestinationTypeSchema ¶
type DestinationTypeSchema struct { Type *string `json:"type,omitempty"` Label *string `json:"label,omitempty"` Description *string `json:"description,omitempty"` // SVG icon string. Icon *string `json:"icon,omitempty"` // Markdown instructions. Instructions *string `json:"instructions,omitempty"` // Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a `remote_setup_url` is set then the user should be prompted to follow the link to configure the destination. // See the [building your own UI guide](https://outpost.hookdeck.com/guides/building-your-own-ui.mdx) for recommended UI patterns and wireframes for implementation in your own app. RemoteSetupURL *string `json:"remote_setup_url,omitempty"` // Config fields are non-secret values that can be stored and displayed to the user in plain text. ConfigFields []DestinationSchemaField `json:"config_fields,omitempty"` // Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic. CredentialFields []DestinationSchemaField `json:"credential_fields,omitempty"` }
func (*DestinationTypeSchema) GetConfigFields ¶
func (o *DestinationTypeSchema) GetConfigFields() []DestinationSchemaField
func (*DestinationTypeSchema) GetCredentialFields ¶
func (o *DestinationTypeSchema) GetCredentialFields() []DestinationSchemaField
func (*DestinationTypeSchema) GetDescription ¶
func (o *DestinationTypeSchema) GetDescription() *string
func (*DestinationTypeSchema) GetIcon ¶
func (o *DestinationTypeSchema) GetIcon() *string
func (*DestinationTypeSchema) GetInstructions ¶
func (o *DestinationTypeSchema) GetInstructions() *string
func (*DestinationTypeSchema) GetLabel ¶
func (o *DestinationTypeSchema) GetLabel() *string
func (*DestinationTypeSchema) GetRemoteSetupURL ¶
func (o *DestinationTypeSchema) GetRemoteSetupURL() *string
func (*DestinationTypeSchema) GetType ¶
func (o *DestinationTypeSchema) GetType() *string
type DestinationUpdate ¶
type DestinationUpdate struct { DestinationUpdateWebhook *DestinationUpdateWebhook `queryParam:"inline"` DestinationUpdateAWSSQS *DestinationUpdateAWSSQS `queryParam:"inline"` DestinationUpdateRabbitMQ *DestinationUpdateRabbitMQ `queryParam:"inline"` DestinationUpdateHookdeck *DestinationUpdateHookdeck `queryParam:"inline"` DestinationUpdateAWSKinesis *DestinationUpdateAWSKinesis `queryParam:"inline"` Type DestinationUpdateType }
func CreateDestinationUpdateDestinationUpdateAWSKinesis ¶
func CreateDestinationUpdateDestinationUpdateAWSKinesis(destinationUpdateAWSKinesis DestinationUpdateAWSKinesis) DestinationUpdate
func CreateDestinationUpdateDestinationUpdateAWSSQS ¶
func CreateDestinationUpdateDestinationUpdateAWSSQS(destinationUpdateAWSSQS DestinationUpdateAWSSQS) DestinationUpdate
func CreateDestinationUpdateDestinationUpdateHookdeck ¶
func CreateDestinationUpdateDestinationUpdateHookdeck(destinationUpdateHookdeck DestinationUpdateHookdeck) DestinationUpdate
func CreateDestinationUpdateDestinationUpdateRabbitMQ ¶
func CreateDestinationUpdateDestinationUpdateRabbitMQ(destinationUpdateRabbitMQ DestinationUpdateRabbitMQ) DestinationUpdate
func CreateDestinationUpdateDestinationUpdateWebhook ¶
func CreateDestinationUpdateDestinationUpdateWebhook(destinationUpdateWebhook DestinationUpdateWebhook) DestinationUpdate
func (DestinationUpdate) MarshalJSON ¶
func (u DestinationUpdate) MarshalJSON() ([]byte, error)
func (*DestinationUpdate) UnmarshalJSON ¶
func (u *DestinationUpdate) UnmarshalJSON(data []byte) error
type DestinationUpdateAWSKinesis ¶
type DestinationUpdateAWSKinesis struct { // "*" or an array of enabled topics. Topics *Topics `json:"topics,omitempty"` Config *AWSKinesisConfig `json:"config,omitempty"` Credentials *AWSKinesisCredentials `json:"credentials,omitempty"` }
func (*DestinationUpdateAWSKinesis) GetConfig ¶
func (o *DestinationUpdateAWSKinesis) GetConfig() *AWSKinesisConfig
func (*DestinationUpdateAWSKinesis) GetCredentials ¶
func (o *DestinationUpdateAWSKinesis) GetCredentials() *AWSKinesisCredentials
func (*DestinationUpdateAWSKinesis) GetTopics ¶
func (o *DestinationUpdateAWSKinesis) GetTopics() *Topics
type DestinationUpdateAWSSQS ¶
type DestinationUpdateAWSSQS struct { // "*" or an array of enabled topics. Topics *Topics `json:"topics,omitempty"` Config *AWSSQSConfig `json:"config,omitempty"` Credentials *AWSSQSCredentials `json:"credentials,omitempty"` }
func (*DestinationUpdateAWSSQS) GetConfig ¶
func (o *DestinationUpdateAWSSQS) GetConfig() *AWSSQSConfig
func (*DestinationUpdateAWSSQS) GetCredentials ¶
func (o *DestinationUpdateAWSSQS) GetCredentials() *AWSSQSCredentials
func (*DestinationUpdateAWSSQS) GetTopics ¶
func (o *DestinationUpdateAWSSQS) GetTopics() *Topics
type DestinationUpdateHookdeck ¶
type DestinationUpdateHookdeck struct { // "*" or an array of enabled topics. Topics *Topics `json:"topics,omitempty"` Config any `json:"config,omitempty"` Credentials *HookdeckCredentials `json:"credentials,omitempty"` }
func (*DestinationUpdateHookdeck) GetConfig ¶
func (o *DestinationUpdateHookdeck) GetConfig() any
func (*DestinationUpdateHookdeck) GetCredentials ¶
func (o *DestinationUpdateHookdeck) GetCredentials() *HookdeckCredentials
func (*DestinationUpdateHookdeck) GetTopics ¶
func (o *DestinationUpdateHookdeck) GetTopics() *Topics
type DestinationUpdateRabbitMQ ¶
type DestinationUpdateRabbitMQ struct { // "*" or an array of enabled topics. Topics *Topics `json:"topics,omitempty"` Config *RabbitMQConfig `json:"config,omitempty"` Credentials *RabbitMQCredentials `json:"credentials,omitempty"` }
func (*DestinationUpdateRabbitMQ) GetConfig ¶
func (o *DestinationUpdateRabbitMQ) GetConfig() *RabbitMQConfig
func (*DestinationUpdateRabbitMQ) GetCredentials ¶
func (o *DestinationUpdateRabbitMQ) GetCredentials() *RabbitMQCredentials
func (*DestinationUpdateRabbitMQ) GetTopics ¶
func (o *DestinationUpdateRabbitMQ) GetTopics() *Topics
type DestinationUpdateType ¶
type DestinationUpdateType string
const ( DestinationUpdateTypeDestinationUpdateWebhook DestinationUpdateType = "DestinationUpdateWebhook" DestinationUpdateTypeDestinationUpdateAWSSQS DestinationUpdateType = "DestinationUpdateAWSSQS" DestinationUpdateTypeDestinationUpdateRabbitMQ DestinationUpdateType = "DestinationUpdateRabbitMQ" DestinationUpdateTypeDestinationUpdateHookdeck DestinationUpdateType = "DestinationUpdateHookdeck" DestinationUpdateTypeDestinationUpdateAWSKinesis DestinationUpdateType = "DestinationUpdateAWSKinesis" )
type DestinationUpdateWebhook ¶
type DestinationUpdateWebhook struct { // "*" or an array of enabled topics. Topics *Topics `json:"topics,omitempty"` Config *WebhookConfig `json:"config,omitempty"` Credentials *WebhookCredentialsUpdate `json:"credentials,omitempty"` }
func (*DestinationUpdateWebhook) GetConfig ¶
func (o *DestinationUpdateWebhook) GetConfig() *WebhookConfig
func (*DestinationUpdateWebhook) GetCredentials ¶
func (o *DestinationUpdateWebhook) GetCredentials() *WebhookCredentialsUpdate
func (*DestinationUpdateWebhook) GetTopics ¶
func (o *DestinationUpdateWebhook) GetTopics() *Topics
type DestinationWebhook ¶
type DestinationWebhook struct { // Control plane generated ID or user provided ID for the destination. ID string `json:"id"` // Type of the destination. Type DestinationWebhookType `json:"type"` // "*" or an array of enabled topics. Topics Topics `json:"topics"` // ISO Date when the destination was disabled, or null if enabled. DisabledAt *time.Time `json:"disabled_at"` // ISO Date when the destination was created. CreatedAt time.Time `json:"created_at"` Config WebhookConfig `json:"config"` Credentials WebhookCredentials `json:"credentials"` // A human-readable representation of the destination target (e.g., URL host). Read-only. Target *string `json:"target,omitempty"` // A URL link to the destination target (the webhook URL). Read-only. TargetURL *string `json:"target_url,omitempty"` }
func (*DestinationWebhook) GetConfig ¶
func (o *DestinationWebhook) GetConfig() WebhookConfig
func (*DestinationWebhook) GetCreatedAt ¶
func (o *DestinationWebhook) GetCreatedAt() time.Time
func (*DestinationWebhook) GetCredentials ¶
func (o *DestinationWebhook) GetCredentials() WebhookCredentials
func (*DestinationWebhook) GetDisabledAt ¶
func (o *DestinationWebhook) GetDisabledAt() *time.Time
func (*DestinationWebhook) GetID ¶
func (o *DestinationWebhook) GetID() string
func (*DestinationWebhook) GetTarget ¶
func (o *DestinationWebhook) GetTarget() *string
func (*DestinationWebhook) GetTargetURL ¶
func (o *DestinationWebhook) GetTargetURL() *string
func (*DestinationWebhook) GetTopics ¶
func (o *DestinationWebhook) GetTopics() Topics
func (*DestinationWebhook) GetType ¶
func (o *DestinationWebhook) GetType() DestinationWebhookType
func (DestinationWebhook) MarshalJSON ¶
func (d DestinationWebhook) MarshalJSON() ([]byte, error)
func (*DestinationWebhook) UnmarshalJSON ¶
func (d *DestinationWebhook) UnmarshalJSON(data []byte) error
type DestinationWebhookType ¶
type DestinationWebhookType string
DestinationWebhookType - Type of the destination.
const (
DestinationWebhookTypeWebhook DestinationWebhookType = "webhook"
)
func (DestinationWebhookType) ToPointer ¶
func (e DestinationWebhookType) ToPointer() *DestinationWebhookType
func (*DestinationWebhookType) UnmarshalJSON ¶
func (e *DestinationWebhookType) UnmarshalJSON(data []byte) error
type Event ¶
type Event struct { ID *string `json:"id,omitempty"` DestinationID *string `json:"destination_id,omitempty"` Topic *string `json:"topic,omitempty"` // Time the event was received/processed. Time *time.Time `json:"time,omitempty"` // Time the event was successfully delivered. SuccessfulAt *time.Time `json:"successful_at,omitempty"` // Key-value string pairs of metadata associated with the event. Metadata map[string]string `json:"metadata,omitempty"` // Freeform JSON data of the event. Data map[string]any `json:"data,omitempty"` }
func (*Event) GetDestinationID ¶
func (*Event) GetMetadata ¶
func (*Event) GetSuccessfulAt ¶
func (Event) MarshalJSON ¶
func (*Event) UnmarshalJSON ¶
type HTTPMetadata ¶
type HTTPMetadata struct { // Raw HTTP response; suitable for custom response parsing Response *http.Response `json:"-"` // Raw HTTP request; suitable for debugging Request *http.Request `json:"-"` }
func (*HTTPMetadata) GetRequest ¶
func (o *HTTPMetadata) GetRequest() *http.Request
func (*HTTPMetadata) GetResponse ¶
func (o *HTTPMetadata) GetResponse() *http.Response
type HookdeckCredentials ¶
type HookdeckCredentials struct { // Hookdeck authentication token. Token string `json:"token"` }
func (*HookdeckCredentials) GetToken ¶
func (o *HookdeckCredentials) GetToken() string
type PortalRedirect ¶
type PortalRedirect struct { // Redirect URL containing a JWT to authenticate the user with the portal. RedirectURL *string `json:"redirect_url,omitempty"` }
func (*PortalRedirect) GetRedirectURL ¶
func (o *PortalRedirect) GetRedirectURL() *string
type PublishRequest ¶
type PublishRequest struct { // Optional. A unique identifier for the event. If not provided, a UUID will be generated. ID *string `json:"id,omitempty"` // The ID of the tenant to publish for. TenantID *string `json:"tenant_id,omitempty"` // Optional. Route event to a specific destination. DestinationID *string `json:"destination_id,omitempty"` // Topic name for the event. Required if Outpost has been configured with topics. Topic *string `json:"topic,omitempty"` // Should event delivery be retried on failure. EligibleForRetry *bool `json:"eligible_for_retry,omitempty"` // Any key-value string pairs for metadata. Metadata map[string]string `json:"metadata,omitempty"` // Any JSON payload for the event data. Data map[string]any `json:"data"` }
func (*PublishRequest) GetData ¶
func (o *PublishRequest) GetData() map[string]any
func (*PublishRequest) GetDestinationID ¶
func (o *PublishRequest) GetDestinationID() *string
func (*PublishRequest) GetEligibleForRetry ¶
func (o *PublishRequest) GetEligibleForRetry() *bool
func (*PublishRequest) GetID ¶ added in v0.2.0
func (o *PublishRequest) GetID() *string
func (*PublishRequest) GetMetadata ¶
func (o *PublishRequest) GetMetadata() map[string]string
func (*PublishRequest) GetTenantID ¶
func (o *PublishRequest) GetTenantID() *string
func (*PublishRequest) GetTopic ¶
func (o *PublishRequest) GetTopic() *string
type PublishResponse ¶ added in v0.2.1
type PublishResponse struct { // The ID of the event that was accepted for publishing. This will be the ID provided in the request's `id` field if present, otherwise it's a server-generated UUID. ID string `json:"id"` }
func (*PublishResponse) GetID ¶ added in v0.2.1
func (o *PublishResponse) GetID() string
type RabbitMQConfig ¶
type RabbitMQConfig struct { // RabbitMQ server address (host:port). ServerURL string `json:"server_url"` // The exchange to publish messages to. Exchange string `json:"exchange"` // Whether to use TLS connection (amqps). Defaults to "false". TLS *TLS `json:"tls,omitempty"` }
func (*RabbitMQConfig) GetExchange ¶
func (o *RabbitMQConfig) GetExchange() string
func (*RabbitMQConfig) GetServerURL ¶
func (o *RabbitMQConfig) GetServerURL() string
func (*RabbitMQConfig) GetTLS ¶
func (o *RabbitMQConfig) GetTLS() *TLS
type RabbitMQCredentials ¶
type RabbitMQCredentials struct { // RabbitMQ username. Username string `json:"username"` // RabbitMQ password. Password string `json:"password"` }
func (*RabbitMQCredentials) GetPassword ¶
func (o *RabbitMQCredentials) GetPassword() string
func (*RabbitMQCredentials) GetUsername ¶
func (o *RabbitMQCredentials) GetUsername() string
type Security ¶
type Security struct { AdminAPIKey *string `security:"scheme,type=http,subtype=bearer,name=Authorization"` TenantJwt *string `security:"scheme,type=http,subtype=bearer,name=Authorization"` }
func (*Security) GetAdminAPIKey ¶
func (*Security) GetTenantJwt ¶
type SuccessResponse ¶
type SuccessResponse struct {
Success *bool `json:"success,omitempty"`
}
func (*SuccessResponse) GetSuccess ¶
func (o *SuccessResponse) GetSuccess() *bool
type TLS ¶
type TLS string
TLS - Whether to use TLS connection (amqps). Defaults to "false".
func (*TLS) UnmarshalJSON ¶
type Tenant ¶
type Tenant struct { // User-defined system ID for the tenant. ID *string `json:"id,omitempty"` // Number of destinations associated with the tenant. DestinationsCount *int64 `json:"destinations_count,omitempty"` // List of subscribed topics across all destinations for this tenant. Topics []string `json:"topics,omitempty"` // ISO Date when the tenant was created. CreatedAt *time.Time `json:"created_at,omitempty"` }
func (*Tenant) GetCreatedAt ¶
func (*Tenant) GetDestinationsCount ¶
func (Tenant) MarshalJSON ¶
func (*Tenant) UnmarshalJSON ¶
type TenantToken ¶
type TenantToken struct { // JWT token scoped to the tenant for safe browser API calls. Token *string `json:"token,omitempty"` }
func (*TenantToken) GetToken ¶
func (o *TenantToken) GetToken() *string
type Topics ¶
type Topics struct { TopicsEnum *TopicsEnum `queryParam:"inline"` ArrayOfStr []string `queryParam:"inline"` Type TopicsType }
Topics - "*" or an array of enabled topics.
func CreateTopicsArrayOfStr ¶
func CreateTopicsTopicsEnum ¶
func CreateTopicsTopicsEnum(topicsEnum TopicsEnum) Topics
func (Topics) MarshalJSON ¶
func (*Topics) UnmarshalJSON ¶
type TopicsEnum ¶
type TopicsEnum string
const (
TopicsEnumWildcard TopicsEnum = "*"
)
func (TopicsEnum) ToPointer ¶
func (e TopicsEnum) ToPointer() *TopicsEnum
func (*TopicsEnum) UnmarshalJSON ¶
func (e *TopicsEnum) UnmarshalJSON(data []byte) error
type TopicsType ¶
type TopicsType string
const ( TopicsTypeTopicsEnum TopicsType = "Topics_enum" TopicsTypeArrayOfStr TopicsType = "arrayOfStr" )
type WebhookConfig ¶
type WebhookConfig struct { // The URL to send the webhook events to. URL string `json:"url"` }
func (*WebhookConfig) GetURL ¶
func (o *WebhookConfig) GetURL() string
type WebhookCredentials ¶
type WebhookCredentials struct { // The secret used for signing webhook requests. Auto-generated if omitted on creation by admin. Read-only for tenants unless rotating. Secret *string `json:"secret,omitempty"` // The previous secret used during rotation. Valid for 24 hours by default. Read-only. PreviousSecret *string `json:"previous_secret,omitempty"` // ISO timestamp when the previous secret becomes invalid. Read-only. PreviousSecretInvalidAt *time.Time `json:"previous_secret_invalid_at,omitempty"` }
func (*WebhookCredentials) GetPreviousSecret ¶
func (o *WebhookCredentials) GetPreviousSecret() *string
func (*WebhookCredentials) GetPreviousSecretInvalidAt ¶
func (o *WebhookCredentials) GetPreviousSecretInvalidAt() *time.Time
func (*WebhookCredentials) GetSecret ¶
func (o *WebhookCredentials) GetSecret() *string
func (WebhookCredentials) MarshalJSON ¶
func (w WebhookCredentials) MarshalJSON() ([]byte, error)
func (*WebhookCredentials) UnmarshalJSON ¶
func (w *WebhookCredentials) UnmarshalJSON(data []byte) error
type WebhookCredentialsUpdate ¶
type WebhookCredentialsUpdate struct { // New secret (only allowed for admin). Secret *string `json:"secret,omitempty"` // Previous secret for rotation (only allowed for admin). PreviousSecret *string `json:"previous_secret,omitempty"` // Invalidation time for previous secret (only allowed for admin). PreviousSecretInvalidAt *time.Time `json:"previous_secret_invalid_at,omitempty"` // Set to true to rotate the secret. The current secret becomes the previous_secret, and a new secret is generated. `previous_secret_invalid_at` defaults to 24h if not provided. RotateSecret *bool `json:"rotate_secret,omitempty"` }
func (*WebhookCredentialsUpdate) GetPreviousSecret ¶
func (o *WebhookCredentialsUpdate) GetPreviousSecret() *string
func (*WebhookCredentialsUpdate) GetPreviousSecretInvalidAt ¶
func (o *WebhookCredentialsUpdate) GetPreviousSecretInvalidAt() *time.Time
func (*WebhookCredentialsUpdate) GetRotateSecret ¶
func (o *WebhookCredentialsUpdate) GetRotateSecret() *bool
func (*WebhookCredentialsUpdate) GetSecret ¶
func (o *WebhookCredentialsUpdate) GetSecret() *string
func (WebhookCredentialsUpdate) MarshalJSON ¶
func (w WebhookCredentialsUpdate) MarshalJSON() ([]byte, error)
func (*WebhookCredentialsUpdate) UnmarshalJSON ¶
func (w *WebhookCredentialsUpdate) UnmarshalJSON(data []byte) error
Source Files
¶
- awskinesisconfig.go
- awskinesiscredentials.go
- awssqsconfig.go
- awssqscredentials.go
- deliveryattempt.go
- destination.go
- destinationawskinesis.go
- destinationawssqs.go
- destinationcreate.go
- destinationcreateawskinesis.go
- destinationcreateawssqs.go
- destinationcreatehookdeck.go
- destinationcreaterabbitmq.go
- destinationcreatewebhook.go
- destinationhookdeck.go
- destinationrabbitmq.go
- destinationschemafield.go
- destinationtypeschema.go
- destinationupdate.go
- destinationupdateawskinesis.go
- destinationupdateawssqs.go
- destinationupdatehookdeck.go
- destinationupdaterabbitmq.go
- destinationupdatewebhook.go
- destinationwebhook.go
- event.go
- hookdeckcredentials.go
- httpmetadata.go
- portalredirect.go
- publishrequest.go
- publishresponse.go
- rabbitmqconfig.go
- rabbitmqcredentials.go
- security.go
- successresponse.go
- tenant.go
- tenanttoken.go
- topics.go
- webhookconfig.go
- webhookcredentials.go
- webhookcredentialsupdate.go