pub

type ConnectRequest struct {
	// The settings the publisher should use to connect, as a JSON string.
	// The JSON will be based on the JSONSchema defined in the publisher's package.json.
	SettingsJson         string   `protobuf:"bytes,2,opt,name=settings_json,json=settingsJson,proto3" json:"settings_json,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConnectResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Count struct {
	Kind                 Count_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=pub.Count_Kind" json:"kind,omitempty"`
	Value                int32      `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

type Count_Kind int32

type DisconnectRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DisconnectResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DiscoverShapesRequest struct {
	// Mode is the discovery mode.
	Mode DiscoverShapesRequest_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=pub.DiscoverShapesRequest_Mode" json:"mode,omitempty"`
	// The shapes to refresh if mode == 1.
	ToRefresh []*Shape `protobuf:"bytes,2,rep,name=to_refresh,json=toRefresh,proto3" json:"to_refresh,omitempty"`
	// Size of the sample of records to include in the returned shapes.
	SampleSize           uint32   `protobuf:"varint,4,opt,name=sample_size,json=sampleSize,proto3" json:"sample_size,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type DiscoverShapesRequest_Mode int32

type DiscoverShapesResponse struct {
	// Shapes discovered by the publisher.
	Shapes               []*Shape `protobuf:"bytes,1,rep,name=shapes,proto3" json:"shapes,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Property struct {
	// ID is the permanent, unique identifier for this property.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name is an optional display name for the property.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of this property, if available.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Type of the property. Use STRING if no other type matches.
	Type PropertyType `protobuf:"varint,4,opt,name=type,proto3,enum=pub.PropertyType" json:"type,omitempty"`
	// Set to true if this property is part of the primary key for this shape.
	IsKey bool `protobuf:"varint,5,opt,name=is_key,json=isKey,proto3" json:"is_key,omitempty"`
	// Set to true if this property is an orderable value which can be used
	// to determine if one record was created more recently than another record.
	// For example, a CreatedAt datetime column or an auto-incrementing integer primary key.
	IsCreateCounter bool `protobuf:"varint,6,opt,name=is_create_counter,json=isCreateCounter,proto3" json:"is_create_counter,omitempty"`
	// Set to true if this property is an orderable value which can be used
	// to determine if one record was updated more recently than another record.
	// For example, an UpdatedAt datetime column.
	IsUpdateCounter bool `protobuf:"varint,7,opt,name=is_update_counter,json=isUpdateCounter,proto3" json:"is_update_counter,omitempty"`
	// Arbitrary JSON blob containing information the publisher uses for things like change detection.
	PublisherMetaJson string `protobuf:"bytes,8,opt,name=publisher_meta_json,json=publisherMetaJson,proto3" json:"publisher_meta_json,omitempty"`
	// The type of the property as defined in the source system. Used to provide
	// human-readable hints when building mappings.
	TypeAtSource string `protobuf:"bytes,9,opt,name=type_at_source,json=typeAtSource,proto3" json:"type_at_source,omitempty"`
	// Indicates that this property is nullable.
	IsNullable           bool     `protobuf:"varint,10,opt,name=is_nullable,json=isNullable,proto3" json:"is_nullable,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type PropertyMetadata struct {
}

type PropertyType int32

type PublishFilter struct {
	// Kind of the match.
	Kind PublishFilter_Kind `protobuf:"varint,1,opt,name=kind,proto3,enum=pub.PublishFilter_Kind" json:"kind,omitempty"`
	// The id of the property on each record which should be matched against the value.
	PropertyId string `protobuf:"bytes,2,opt,name=property_id,json=propertyId,proto3" json:"property_id,omitempty"`
	// The value of the which should be matched against the named property for each record, as a string.
	// The publisher is responsible for converting the value to the correct type.
	Value                string   `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type PublishFilter_Kind int32

type PublishRequest struct {
	// The shape of the records to publish.
	Shape *Shape `protobuf:"bytes,1,opt,name=shape,proto3" json:"shape,omitempty"`
	// Limit of number of records to return.
	Limit uint32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// Zero or more filters which should be applied to the returned records.
	Filters              []*PublishFilter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

type PublisherClient interface {
	// Instructs the publisher to connect to its data source.
	Connect(ctx context.Context, in *ConnectRequest, opts ...grpc.CallOption) (*ConnectResponse, error)
	// Requests a listing of shapes this publisher can provide records for.
	DiscoverShapes(ctx context.Context, in *DiscoverShapesRequest, opts ...grpc.CallOption) (*DiscoverShapesResponse, error)
	// PublishString begins streaming records to the client from the plugin.
	PublishStream(ctx context.Context, in *PublishRequest, opts ...grpc.CallOption) (Publisher_PublishStreamClient, error)
	// Tells the publisher to disconnect from its data source, stop any running publishes,
	// and gracefully prepare to be shut down.
	Disconnect(ctx context.Context, in *DisconnectRequest, opts ...grpc.CallOption) (*DisconnectResponse, error)
}

type PublisherServer interface {
	// Instructs the publisher to connect to its data source.
	Connect(context.Context, *ConnectRequest) (*ConnectResponse, error)
	// Requests a listing of shapes this publisher can provide records for.
	DiscoverShapes(context.Context, *DiscoverShapesRequest) (*DiscoverShapesResponse, error)
	// PublishString begins streaming records to the client from the plugin.
	PublishStream(*PublishRequest, Publisher_PublishStreamServer) error
	// Tells the publisher to disconnect from its data source, stop any running publishes,
	// and gracefully prepare to be shut down.
	Disconnect(context.Context, *DisconnectRequest) (*DisconnectResponse, error)
}

type Publisher_PublishStreamClient interface {
	Recv() (*Record, error)
	grpc.ClientStream
}

type Publisher_PublishStreamServer interface {
	Send(*Record) error
	grpc.ServerStream
}

type Record struct {
	// Action for this record. Default value is UPSERT if the plugin
	// cannot determine what the action should be relative to data alreay acquired.
	Action Record_Action `protobuf:"varint,1,opt,name=action,proto3,enum=pub.Record_Action" json:"action,omitempty"`
	// Data for this record, as a JSON string.
	DataJson             string   `protobuf:"bytes,2,opt,name=data_json,json=dataJson,proto3" json:"data_json,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Record_Action int32

type Shape struct {
	// ID that the plugin uses to uniquely identify this shape.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of this shape (must be a permanant identifier which is unique in this source).
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of this shape, if available.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Properties of this shape.
	Properties []*Property `protobuf:"bytes,4,rep,name=properties,proto3" json:"properties,omitempty"`
	// Count of records available in this shape.
	Count *Count `protobuf:"bytes,5,opt,name=count,proto3" json:"count,omitempty"`
	// Sample containing zero or more records representative of the data in this shape.
	Sample []*Record `protobuf:"bytes,6,rep,name=sample,proto3" json:"sample,omitempty"`
	// When returned from a publisher, the optional query which can be passed to the publisher to publish records from this shape.
	// When passed to the publisher, the query which should be used to publish records from this shape.
	Query string `protobuf:"bytes,7,opt,name=query,proto3" json:"query,omitempty"`
	// Arbitrary JSON blob containing information the publisher uses for things like change detection.
	PublisherMetaJson string `protobuf:"bytes,8,opt,name=publisher_meta_json,json=publisherMetaJson,proto3" json:"publisher_meta_json,omitempty"`
	// Errors that occurred while discovering this shape.
	Errors               []string `protobuf:"bytes,9,rep,name=errors,proto3" json:"errors,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ShapeMetadata struct {
}

type SortableProperties []*Property

type SortableShapes []*Shape