connectorv1

type Destination struct {
	// contains filtered or unexported fields
}

type DestinationPluginClient interface {
	// Configure is the first function to be called in a plugin. It provides the
	// plugin with the configuration that needs to be validated and stored. In
	// case the configuration is not valid it should return an error status.
	Configure(ctx context.Context, in *Destination_Configure_Request, opts ...grpc.CallOption) (*Destination_Configure_Response, error)
	// Start is called after Configure to signal the plugin it can prepare to
	// start writing records. If needed, the plugin should open connections in
	// this function.
	Start(ctx context.Context, in *Destination_Start_Request, opts ...grpc.CallOption) (*Destination_Start_Response, error)
	// Run will open a bidirectional stream between Conduit and the plugin.
	// Conduit will be streaming records to the plugin that should be written
	// to the 3rd party resource. The plugin is responsible for sending
	// acknowledgments back to Conduit once a record has been processed. The
	// acknowledgment should contain an error in case a record could not be
	// successfully processed. The stream should still stay open in case Conduit
	// is able to recover from the error and the pipeline keeps running.
	Run(ctx context.Context, opts ...grpc.CallOption) (DestinationPlugin_RunClient, error)
	// Stop signals to the plugin that the record with the specified position is
	// the last one and no more records will be written to the stream after it.
	// Once the plugin receives the last record it should flush any records that
	// might be cached and not yet written to the 3rd party resource.
	Stop(ctx context.Context, in *Destination_Stop_Request, opts ...grpc.CallOption) (*Destination_Stop_Response, error)
	// Teardown signals to the plugin that there will be no more calls to any
	// other function. After Teardown returns, the plugin should be ready for a
	// graceful shutdown.
	Teardown(ctx context.Context, in *Destination_Teardown_Request, opts ...grpc.CallOption) (*Destination_Teardown_Response, error)
	// LifecycleOnCreated is called after Configure and before Start when the
	// connector is run for the first time. This call will be skipped if a
	// connector was already started before. This method can be used to do some
	// initialization that needs to happen only once in the lifetime of a
	// connector (e.g. create a bucket). Anything that the connector creates in
	// this method is considered to be owned by this connector and should be
	// cleaned up in LifecycleOnDeleted.
	LifecycleOnCreated(ctx context.Context, in *Destination_Lifecycle_OnCreated_Request, opts ...grpc.CallOption) (*Destination_Lifecycle_OnCreated_Response, error)
	// LifecycleOnUpdated is called after Configure and before Start when the
	// connector configuration has changed since the last run. This call will be
	// skipped if the connector configuration did not change. It can be used to
	// update anything that was initialized in LifecycleOnCreated, in case the
	// configuration change affects it.
	LifecycleOnUpdated(ctx context.Context, in *Destination_Lifecycle_OnUpdated_Request, opts ...grpc.CallOption) (*Destination_Lifecycle_OnUpdated_Response, error)
	// LifecycleOnDeleted is called when the connector was deleted. It will be the
	// only method that is called in that case. This method can be used to clean
	// up anything that was initialized in LifecycleOnCreated.
	LifecycleOnDeleted(ctx context.Context, in *Destination_Lifecycle_OnDeleted_Request, opts ...grpc.CallOption) (*Destination_Lifecycle_OnDeleted_Response, error)
}

type DestinationPluginServer interface {
	// Configure is the first function to be called in a plugin. It provides the
	// plugin with the configuration that needs to be validated and stored. In
	// case the configuration is not valid it should return an error status.
	Configure(context.Context, *Destination_Configure_Request) (*Destination_Configure_Response, error)
	// Start is called after Configure to signal the plugin it can prepare to
	// start writing records. If needed, the plugin should open connections in
	// this function.
	Start(context.Context, *Destination_Start_Request) (*Destination_Start_Response, error)
	// Run will open a bidirectional stream between Conduit and the plugin.
	// Conduit will be streaming records to the plugin that should be written
	// to the 3rd party resource. The plugin is responsible for sending
	// acknowledgments back to Conduit once a record has been processed. The
	// acknowledgment should contain an error in case a record could not be
	// successfully processed. The stream should still stay open in case Conduit
	// is able to recover from the error and the pipeline keeps running.
	Run(DestinationPlugin_RunServer) error
	// Stop signals to the plugin that the record with the specified position is
	// the last one and no more records will be written to the stream after it.
	// Once the plugin receives the last record it should flush any records that
	// might be cached and not yet written to the 3rd party resource.
	Stop(context.Context, *Destination_Stop_Request) (*Destination_Stop_Response, error)
	// Teardown signals to the plugin that there will be no more calls to any
	// other function. After Teardown returns, the plugin should be ready for a
	// graceful shutdown.
	Teardown(context.Context, *Destination_Teardown_Request) (*Destination_Teardown_Response, error)
	// LifecycleOnCreated is called after Configure and before Start when the
	// connector is run for the first time. This call will be skipped if a
	// connector was already started before. This method can be used to do some
	// initialization that needs to happen only once in the lifetime of a
	// connector (e.g. create a bucket). Anything that the connector creates in
	// this method is considered to be owned by this connector and should be
	// cleaned up in LifecycleOnDeleted.
	LifecycleOnCreated(context.Context, *Destination_Lifecycle_OnCreated_Request) (*Destination_Lifecycle_OnCreated_Response, error)
	// LifecycleOnUpdated is called after Configure and before Start when the
	// connector configuration has changed since the last run. This call will be
	// skipped if the connector configuration did not change. It can be used to
	// update anything that was initialized in LifecycleOnCreated, in case the
	// configuration change affects it.
	LifecycleOnUpdated(context.Context, *Destination_Lifecycle_OnUpdated_Request) (*Destination_Lifecycle_OnUpdated_Response, error)
	// LifecycleOnDeleted is called when the connector was deleted. It will be the
	// only method that is called in that case. This method can be used to clean
	// up anything that was initialized in LifecycleOnCreated.
	LifecycleOnDeleted(context.Context, *Destination_Lifecycle_OnDeleted_Request) (*Destination_Lifecycle_OnDeleted_Response, error)
	// contains filtered or unexported methods
}

type DestinationPlugin_RunClient interface {
	Send(*Destination_Run_Request) error
	Recv() (*Destination_Run_Response, error)
	grpc.ClientStream
}

type DestinationPlugin_RunServer interface {
	Send(*Destination_Run_Response) error
	Recv() (*Destination_Run_Request, error)
	grpc.ServerStream
}

type Destination_Configure struct {
	// contains filtered or unexported fields
}

type Destination_Configure_Request struct {

	// Config contains the raw plugin settings.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Destination_Configure_Response struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnCreated struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnCreated_Request struct {

	// This is the connector configuration that was also passed to
	// Configure, therefore it's already validated.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnCreated_Response struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnDeleted struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnDeleted_Request struct {

	// This is the old connector configuration that was used the last time
	// the connector was running. It was valid at that time, since it passed
	// through the Configure function.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnDeleted_Response struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnUpdated struct {
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnUpdated_Request struct {

	// This is the old connector configuration that was used the last time
	// the connector was running. It was valid at that time, since it passed
	// through the Configure function.
	ConfigBefore map[string]string `` /* 185-byte string literal not displayed */
	// This is the new connector configuration that was also passed to
	// Configure, therefore it's already validated.
	ConfigAfter map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Destination_Lifecycle_OnUpdated_Response struct {
	// contains filtered or unexported fields
}

type Destination_Run struct {
	// contains filtered or unexported fields
}

type Destination_Run_Request struct {

	// Record contains the OpenCDC record that should be written to the 3rd
	// party resource.
	Record *v1.Record `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
	// contains filtered or unexported fields
}

type Destination_Run_Response struct {

	// This is the position of the record that was processed.
	AckPosition []byte `protobuf:"bytes,1,opt,name=ack_position,json=ackPosition,proto3" json:"ack_position,omitempty"`
	// Error should be empty if the record was successfully processed or
	// should contain a descriptive message in case the record
	// processing failed.
	Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

type Destination_Start struct {
	// contains filtered or unexported fields
}

type Destination_Start_Request struct {
	// contains filtered or unexported fields
}

type Destination_Start_Response struct {
	// contains filtered or unexported fields
}

type Destination_Stop struct {
	// contains filtered or unexported fields
}

type Destination_Stop_Request struct {

	// This is the position of the last record that was sent into the stream.
	// Conduit won't send any records after a record with this position is
	// received.
	LastPosition []byte `protobuf:"bytes,1,opt,name=last_position,json=lastPosition,proto3" json:"last_position,omitempty"`
	// contains filtered or unexported fields
}

type Destination_Stop_Response struct {
	// contains filtered or unexported fields
}

type Destination_Teardown struct {
	// contains filtered or unexported fields
}

type Destination_Teardown_Request struct {
	// contains filtered or unexported fields
}

type Destination_Teardown_Response struct {
	// contains filtered or unexported fields
}

type Source struct {
	// contains filtered or unexported fields
}

type SourcePluginClient interface {
	// Configure is the first function to be called in a plugin. It provides the
	// plugin with the configuration that needs to be validated and stored. In
	// case the configuration is not valid it should return an error status.
	Configure(ctx context.Context, in *Source_Configure_Request, opts ...grpc.CallOption) (*Source_Configure_Response, error)
	// Start is called after Configure to signal the plugin it can prepare to
	// start producing records. If needed, the plugin should open connections in
	// this function. The position parameter will contain the position of the
	// last record that was successfully processed. The Source should therefore
	// start producing records after this position.
	Start(ctx context.Context, in *Source_Start_Request, opts ...grpc.CallOption) (*Source_Start_Response, error)
	// Run will open a bidirectional stream between Conduit and the plugin.
	// The plugin is responsible for fetching records from 3rd party resources
	// and sending them as responses to Conduit. Conduit will process the
	// records asynchronously and send acknowledgments back to the plugin to
	// signal that a record at a certain position was processed. Acknowledgments
	// will be sent back to the connector in the same order as the records
	// produced by the connector. If a record could not be processed by Conduit,
	// the stream will be closed without an acknowledgment being sent back to the
	// connector.
	Run(ctx context.Context, opts ...grpc.CallOption) (SourcePlugin_RunClient, error)
	// Stop signals to the plugin to stop retrieving new records and flush any
	// records that might be cached into the stream. It should block until it can
	// determine the last record that will be sent to the stream and return the
	// position of the last record. Conduit will keep the stream open until it
	// receives the last record and sends back any outstanding acknowledgments.
	// If Conduit did not send an acknowledgment for a record after the stream is
	// closed, it should be interpreted as a negative acknowledgment.
	Stop(ctx context.Context, in *Source_Stop_Request, opts ...grpc.CallOption) (*Source_Stop_Response, error)
	// Teardown signals to the plugin that there will be no more calls to any
	// other function. After Teardown returns, the plugin should be ready for a
	// graceful shutdown.
	Teardown(ctx context.Context, in *Source_Teardown_Request, opts ...grpc.CallOption) (*Source_Teardown_Response, error)
	// LifecycleOnCreated is called after Configure and before Start when the
	// connector is run for the first time. This call will be skipped if a
	// connector was already started before. This method can be used to do some
	// initialization that needs to happen only once in the lifetime of a
	// connector (e.g. create a replication slot). Anything that the connector
	// creates in this method is considered to be owned by this connector and
	// should be cleaned up in LifecycleOnDeleted.
	LifecycleOnCreated(ctx context.Context, in *Source_Lifecycle_OnCreated_Request, opts ...grpc.CallOption) (*Source_Lifecycle_OnCreated_Response, error)
	// LifecycleOnUpdated is called after Configure and before Start when the
	// connector configuration has changed since the last run. This call will be
	// skipped if the connector configuration did not change. It can be used to
	// update anything that was initialized in LifecycleOnCreated, in case the
	// configuration change affects it.
	LifecycleOnUpdated(ctx context.Context, in *Source_Lifecycle_OnUpdated_Request, opts ...grpc.CallOption) (*Source_Lifecycle_OnUpdated_Response, error)
	// LifecycleOnDeleted is called when the connector was deleted. It will be the
	// only method that is called in that case. This method can be used to clean
	// up anything that was initialized in LifecycleOnCreated.
	LifecycleOnDeleted(ctx context.Context, in *Source_Lifecycle_OnDeleted_Request, opts ...grpc.CallOption) (*Source_Lifecycle_OnDeleted_Response, error)
}

type SourcePluginServer interface {
	// Configure is the first function to be called in a plugin. It provides the
	// plugin with the configuration that needs to be validated and stored. In
	// case the configuration is not valid it should return an error status.
	Configure(context.Context, *Source_Configure_Request) (*Source_Configure_Response, error)
	// Start is called after Configure to signal the plugin it can prepare to
	// start producing records. If needed, the plugin should open connections in
	// this function. The position parameter will contain the position of the
	// last record that was successfully processed. The Source should therefore
	// start producing records after this position.
	Start(context.Context, *Source_Start_Request) (*Source_Start_Response, error)
	// Run will open a bidirectional stream between Conduit and the plugin.
	// The plugin is responsible for fetching records from 3rd party resources
	// and sending them as responses to Conduit. Conduit will process the
	// records asynchronously and send acknowledgments back to the plugin to
	// signal that a record at a certain position was processed. Acknowledgments
	// will be sent back to the connector in the same order as the records
	// produced by the connector. If a record could not be processed by Conduit,
	// the stream will be closed without an acknowledgment being sent back to the
	// connector.
	Run(SourcePlugin_RunServer) error
	// Stop signals to the plugin to stop retrieving new records and flush any
	// records that might be cached into the stream. It should block until it can
	// determine the last record that will be sent to the stream and return the
	// position of the last record. Conduit will keep the stream open until it
	// receives the last record and sends back any outstanding acknowledgments.
	// If Conduit did not send an acknowledgment for a record after the stream is
	// closed, it should be interpreted as a negative acknowledgment.
	Stop(context.Context, *Source_Stop_Request) (*Source_Stop_Response, error)
	// Teardown signals to the plugin that there will be no more calls to any
	// other function. After Teardown returns, the plugin should be ready for a
	// graceful shutdown.
	Teardown(context.Context, *Source_Teardown_Request) (*Source_Teardown_Response, error)
	// LifecycleOnCreated is called after Configure and before Start when the
	// connector is run for the first time. This call will be skipped if a
	// connector was already started before. This method can be used to do some
	// initialization that needs to happen only once in the lifetime of a
	// connector (e.g. create a replication slot). Anything that the connector
	// creates in this method is considered to be owned by this connector and
	// should be cleaned up in LifecycleOnDeleted.
	LifecycleOnCreated(context.Context, *Source_Lifecycle_OnCreated_Request) (*Source_Lifecycle_OnCreated_Response, error)
	// LifecycleOnUpdated is called after Configure and before Start when the
	// connector configuration has changed since the last run. This call will be
	// skipped if the connector configuration did not change. It can be used to
	// update anything that was initialized in LifecycleOnCreated, in case the
	// configuration change affects it.
	LifecycleOnUpdated(context.Context, *Source_Lifecycle_OnUpdated_Request) (*Source_Lifecycle_OnUpdated_Response, error)
	// LifecycleOnDeleted is called when the connector was deleted. It will be the
	// only method that is called in that case. This method can be used to clean
	// up anything that was initialized in LifecycleOnCreated.
	LifecycleOnDeleted(context.Context, *Source_Lifecycle_OnDeleted_Request) (*Source_Lifecycle_OnDeleted_Response, error)
	// contains filtered or unexported methods
}

type SourcePlugin_RunClient interface {
	Send(*Source_Run_Request) error
	Recv() (*Source_Run_Response, error)
	grpc.ClientStream
}

type SourcePlugin_RunServer interface {
	Send(*Source_Run_Response) error
	Recv() (*Source_Run_Request, error)
	grpc.ServerStream
}

type Source_Configure struct {
	// contains filtered or unexported fields
}

type Source_Configure_Request struct {

	// Config contains the raw plugin settings.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Source_Configure_Response struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnCreated struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnCreated_Request struct {

	// This is the connector configuration that was also passed to
	// Configure, therefore it's already validated.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnCreated_Response struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnDeleted struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnDeleted_Request struct {

	// This is the old connector configuration that was used the last time
	// the connector was running. It was valid at that time, since it passed
	// through the Configure function.
	Config map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnDeleted_Response struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnUpdated struct {
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnUpdated_Request struct {

	// This is the old connector configuration that was used the last time
	// the connector was running. It was valid at that time, since it passed
	// through the Configure function.
	ConfigBefore map[string]string `` /* 185-byte string literal not displayed */
	// This is the new connector configuration that was also passed to
	// Configure, therefore it's already validated.
	ConfigAfter map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

type Source_Lifecycle_OnUpdated_Response struct {
	// contains filtered or unexported fields
}

type Source_Run struct {
	// contains filtered or unexported fields
}

type Source_Run_Request struct {

	// This is the position of the record that was successfully
	// processed.
	AckPosition []byte `protobuf:"bytes,1,opt,name=ack_position,json=ackPosition,proto3" json:"ack_position,omitempty"`
	// contains filtered or unexported fields
}

type Source_Run_Response struct {

	// Record contains the OpenCDC record read by the source from the 3rd
	// party resource.
	Record *v1.Record `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
	// contains filtered or unexported fields
}

type Source_Start struct {
	// contains filtered or unexported fields
}

type Source_Start_Request struct {

	// This is the position of the last record that was successfully
	// processed. The Source should start producing records after this
	// position.
	Position []byte `protobuf:"bytes,1,opt,name=position,proto3" json:"position,omitempty"`
	// contains filtered or unexported fields
}

type Source_Start_Response struct {
	// contains filtered or unexported fields
}

type Source_Stop struct {
	// contains filtered or unexported fields
}

type Source_Stop_Request struct {
	// contains filtered or unexported fields
}

type Source_Stop_Response struct {

	// This is the position of the last record in the stream, Conduit
	// won't process records after this position anymore. After the
	// record with this position is received by Conduit and all
	// outstanding acknowledgments were delivered to the connector, the
	// stream will be closed.
	LastPosition []byte `protobuf:"bytes,1,opt,name=last_position,json=lastPosition,proto3" json:"last_position,omitempty"`
	// contains filtered or unexported fields
}

type Source_Teardown struct {
	// contains filtered or unexported fields
}

type Source_Teardown_Request struct {
	// contains filtered or unexported fields
}

type Source_Teardown_Response struct {
	// contains filtered or unexported fields
}

type Specifier struct {
	// contains filtered or unexported fields
}

type SpecifierPluginClient interface {
	// Specify should return the plugin specification.
	Specify(ctx context.Context, in *Specifier_Specify_Request, opts ...grpc.CallOption) (*Specifier_Specify_Response, error)
}

type SpecifierPluginServer interface {
	// Specify should return the plugin specification.
	Specify(context.Context, *Specifier_Specify_Request) (*Specifier_Specify_Response, error)
	// contains filtered or unexported methods
}

type Specifier_Parameter struct {

	// Default is the default value of the parameter. If there is no default
	// value use an empty string.
	Default string `protobuf:"bytes,1,opt,name=default,proto3" json:"default,omitempty"`
	// Required defines whether the parameter has to be provided when
	// configuring the plugin.
	// Deprecated: add a validation of type TYPE_REQUIRED to the validations list.
	//
	// Deprecated: Marked as deprecated in connector/v1/connector.proto.
	Required bool `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	// Description explains what the parameter does and how to configure it.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Type defines the parameter data type.
	Type Specifier_Parameter_Type `protobuf:"varint,4,opt,name=type,proto3,enum=connector.v1.Specifier_Parameter_Type" json:"type,omitempty"`
	// Validations are validations to be made on the parameter.
	Validations []*Specifier_Parameter_Validation `protobuf:"bytes,5,rep,name=validations,proto3" json:"validations,omitempty"`
	// contains filtered or unexported fields
}

type Specifier_Parameter_Type int32

type Specifier_Parameter_Validation struct {
	Type Specifier_Parameter_Validation_Type `protobuf:"varint,1,opt,name=type,proto3,enum=connector.v1.Specifier_Parameter_Validation_Type" json:"type,omitempty"`
	// The value to be compared with the parameter,
	// or a comma separated list in case of Validation.TYPE_INCLUSION or Validation.TYPE_EXCLUSION.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type Specifier_Parameter_Validation_Type int32

type Specifier_Specify struct {
	// contains filtered or unexported fields
}

type Specifier_Specify_Request struct {
	// contains filtered or unexported fields
}

type Specifier_Specify_Response struct {

	// Name is the name of the plugin.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Summary is a brief description of the plugin and what it does,
	// ideally not longer than one sentence.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// Description is a longer form field, appropriate for README-like
	// text that the author can provide for documentation about the
	// usage of the plugin.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Version string. Should follow semantic versioning and use the "v"
	// prefix (e.g. v1.23.4).
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Author declares the entity that created or maintains this plugin.
	Author string `protobuf:"bytes,5,opt,name=author,proto3" json:"author,omitempty"`
	// A map that describes parameters available for configuring the
	// destination plugin.
	DestinationParams map[string]*Specifier_Parameter `` /* 200-byte string literal not displayed */
	// A map that describes parameters available for configuring the
	// source plugin.
	SourceParams map[string]*Specifier_Parameter `` /* 185-byte string literal not displayed */
	// contains filtered or unexported fields
}

type UnimplementedDestinationPluginServer struct {
}

type UnimplementedSourcePluginServer struct {
}

type UnimplementedSpecifierPluginServer struct {
}

type UnsafeDestinationPluginServer interface {
	// contains filtered or unexported methods
}

type UnsafeSourcePluginServer interface {
	// contains filtered or unexported methods
}

type UnsafeSpecifierPluginServer interface {
	// contains filtered or unexported methods
}