pub

type BeginOAuthFlowRequest struct {
	Configuration *OAuthConfiguration `protobuf:"bytes,1,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// The URL that the auth server should send the authorization token to.
	RedirectUrl          string   `protobuf:"bytes,2,opt,name=redirect_url,json=redirectUrl,proto3" json:"redirect_url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type BeginOAuthFlowResponse struct {
	// The URL the user should use to start the authorization process.
	AuthorizationUrl     string   `protobuf:"bytes,1,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type CompleteOAuthFlowRequest struct {
	Configuration *OAuthConfiguration `protobuf:"bytes,1,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// The URL that the OAuth flow redirected the user to after authentication.
	// If the response_mode was 'query' this will contain the token.
	RedirectUrl string `protobuf:"bytes,2,opt,name=redirect_url,json=redirectUrl,proto3" json:"redirect_url,omitempty"`
	// The body that the OAuth flow caused to be posted if the response_mode
	// for the redirect was 'form_post'.
	RedirectBody         string   `protobuf:"bytes,3,opt,name=redirect_body,json=redirectBody,proto3" json:"redirect_body,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type CompleteOAuthFlowResponse struct {
	// JSON data containing the OAuth information the plugin wants
	// to be passed to any connect request.
	OauthStateJson       string   `protobuf:"bytes,1,opt,name=oauth_state_json,json=oauthStateJson,proto3" json:"oauth_state_json,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConfigurationFormRequest struct {
	// JSON object containing the current values of the settings
	// as entered into the UI.
	DataJson string `protobuf:"bytes,1,opt,name=data_json,json=dataJson,proto3" json:"data_json,omitempty"`
	// Opaque state object from the most recent Configure*Response.
	StateJson string `protobuf:"bytes,2,opt,name=state_json,json=stateJson,proto3" json:"state_json,omitempty"`
	// If true, the user has indicated that they want to save the current
	// settings, so the plugin should perform final validation
	// and may attempt to perform any destructive actions needed
	// to apply the settings.
	IsSave               bool     `protobuf:"varint,3,opt,name=is_save,json=isSave,proto3" json:"is_save,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConfigurationFormResponse struct {
	// The JSONSchema which should be used to build the form.
	SchemaJson string `protobuf:"bytes,1,opt,name=schema_json,json=schemaJson,proto3" json:"schema_json,omitempty"`
	// The UI hints which should be provided to the form.
	UiJson string `protobuf:"bytes,2,opt,name=ui_json,json=uiJson,proto3" json:"ui_json,omitempty"`
	// The state object which should be passed in any future Configure*Request as
	// part of this configuration session.
	StateJson string `protobuf:"bytes,3,opt,name=state_json,json=stateJson,proto3" json:"state_json,omitempty"`
	// Current values from the form.
	DataJson string `protobuf:"bytes,4,opt,name=data_json,json=dataJson,proto3" json:"data_json,omitempty"`
	// Errors which should be displayed attached to fields in the form,
	// in the form of a JSON object with the same schema as the data object,
	// but the values are arrays of strings containing the error messages.
	DataErrorsJson string `protobuf:"bytes,5,opt,name=data_errors_json,json=dataErrorsJson,proto3" json:"data_errors_json,omitempty"`
	// Generic errors which should be displayed at the bottom of the form,
	// not associated with any specific fields.
	Errors               []string `protobuf:"bytes,6,rep,name=errors,proto3" json:"errors,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConfigurationFormResponseBuilder struct {
	Response   *ConfigurationFormResponse
	FormSchema *jsonschema.JSONSchema
	UISchema   map[string]interface{}
	Data       map[string]interface{}
}

type ConfigureConnectionRequest struct {
	// The form state for the request.
	Form *ConfigurationFormRequest `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// An embedded ConnectRequest to support passing
	// OAuth secrets into the connection configuration operation.
	ConnectRequest       *ConnectRequest `protobuf:"bytes,2,opt,name=connect_request,json=connectRequest,proto3" json:"connect_request,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

type ConfigureConnectionResponse struct {
	Form *ConfigurationFormResponse `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// An embedded ConnectResponse to support returning
	// updated OAuth secrets from the connection configuration operation
	// if the secrets have been updated.
	ConnectResponse      *ConnectResponse `protobuf:"bytes,2,opt,name=connect_response,json=connectResponse,proto3" json:"connect_response,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

type ConfigureQueryRequest struct {
	// The form state for the request.
	Form                 *ConfigurationFormRequest `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

type ConfigureQueryResponse struct {
	Form *ConfigurationFormResponse `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// The schema that this query will produce.
	Schema               *Schema  `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConfigureRealTimeRequest struct {
	// The form state for the request.
	Form *ConfigurationFormRequest `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// The schema (schema) which is being targeted for real time publishing.
	Schema               *Schema  `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type ConfigureRealTimeResponse struct {
	Form                 *ConfigurationFormResponse `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

type ConfigureReplicationRequest struct {
	// Configuration object to build the ui
	Form *ConfigurationFormRequest `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// The schema (based on a shape) which is being replicated.
	Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	// The versions which will be written back with this replication.
	Versions             []*ReplicationWriteVersion `protobuf:"bytes,3,rep,name=versions,proto3" json:"versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

type ConfigureReplicationResponse struct {
	// Configuration object to build the ui
	Form                 *ConfigurationFormResponse `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                   `json:"-"`
	XXX_unrecognized     []byte                     `json:"-"`
	XXX_sizecache        int32                      `json:"-"`
}

type ConfigureRequest struct {
	// The level of logging information the plugin should emit.
	LogLevel LogLevel `protobuf:"varint,1,opt,name=log_level,json=logLevel,proto3,enum=pub.LogLevel" json:"log_level,omitempty"`
	// Directory where log files should be stored.
	LogDirectory string `protobuf:"bytes,2,opt,name=log_directory,json=logDirectory,proto3" json:"log_directory,omitempty"`
	// Directory where the plugin can store data permanently.
	PermanentDirectory string `protobuf:"bytes,3,opt,name=permanent_directory,json=permanentDirectory,proto3" json:"permanent_directory,omitempty"`
	// Directory where the plugin can store temporary information which may be
	// deleted.
	TemporaryDirectory string `protobuf:"bytes,4,opt,name=temporary_directory,json=temporaryDirectory,proto3" json:"temporary_directory,omitempty"`
	// Data versions which will be in effect until the next configure request.
	// This can be used to name log files or caches.
	DataVersions         *DataVersions `protobuf:"bytes,5,opt,name=data_versions,json=dataVersions,proto3" json:"data_versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

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

type ConfigureWriteRequest struct {
	// The form state for the request.
	Form                 *ConfigurationFormRequest `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

type ConfigureWriteResponse struct {
	// Configuration object to build the ui
	Form *ConfigurationFormResponse `protobuf:"bytes,1,opt,name=form,proto3" json:"form,omitempty"`
	// The schema (schema) which is being targeted for write backs.
	Schema               *Schema  `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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"`
	// OAuth configuration information which the plugin may need to
	// obtain an access token using the OAuth state.
	OauthConfiguration *OAuthConfiguration `protobuf:"bytes,3,opt,name=oauth_configuration,json=oauthConfiguration,proto3" json:"oauth_configuration,omitempty"`
	// The OAuth state returned from the last Connect, ConnectSession, or
	// CompleteOAuthFlow.
	OauthStateJson string `protobuf:"bytes,4,opt,name=oauth_state_json,json=oauthStateJson,proto3" json:"oauth_state_json,omitempty"`
	// Data versions which will be in effect until the next configure request.
	// This can be used to name log files or caches.
	DataVersions         *DataVersions `protobuf:"bytes,5,opt,name=data_versions,json=dataVersions,proto3" json:"data_versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

type ConnectResponse struct {
	// If connection settings are invalid, this should contain the problem.
	SettingsError string `protobuf:"bytes,1,opt,name=settings_error,json=settingsError,proto3" json:"settings_error,omitempty"`
	// If the connection settings appear valid, connecting to the target system
	// failed, this should contain the error from the target system.
	ConnectionError string `protobuf:"bytes,2,opt,name=connection_error,json=connectionError,proto3" json:"connection_error,omitempty"`
	// If the OAuth state is invalid or expired, this should contain a description
	// of the problem.
	OauthError string `protobuf:"bytes,3,opt,name=oauth_error,json=oauthError,proto3" json:"oauth_error,omitempty"`
	// The OAuth data which should be stored securely and passed next time
	// a connection is requested. This is returned by Connect because
	// forming the connection may have used up a refresh token and
	// the new refresh token must now be stored.
	OauthStateJson       string   `protobuf:"bytes,4,opt,name=oauth_state_json,json=oauthStateJson,proto3" json:"oauth_state_json,omitempty"`
	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 DataVersions struct {
	// The ID of the job related to this request, if any. Can be used to
	// name caches related to a specific job.
	JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// The data version of the job related to this request. When this increments,
	// any cached data associated with the job should be discarded.
	JobDataVersion uint32 `protobuf:"varint,2,opt,name=job_data_version,json=jobDataVersion,proto3" json:"job_data_version,omitempty"`
	// The ID of the shape related to this request, if any. Can be used to
	// name caches related to a specific shape.
	ShapeId string `protobuf:"bytes,3,opt,name=shape_id,json=shapeId,proto3" json:"shape_id,omitempty"`
	// The data version of the shape related to this request. When this
	// increments, any cached data associated with the shape should be discarded.
	ShapeDataVersion     uint32   `protobuf:"varint,4,opt,name=shape_data_version,json=shapeDataVersion,proto3" json:"shape_data_version,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 DiscoverRelatedEntitiesRequest struct {
	// The schemas to discover related entities for
	ToRelate             []*Schema `protobuf:"bytes,1,rep,name=to_relate,json=toRelate,proto3" json:"to_relate,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

type DiscoverRelatedEntitiesResponse struct {
	// Related entities discovered by the publisher.
	RelatedEntities      []*RelatedEntity `protobuf:"bytes,1,rep,name=related_entities,json=relatedEntities,proto3" json:"related_entities,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

type DiscoverSchemasRequest struct {
	// Mode is the discovery mode.
	Mode DiscoverSchemasRequest_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=pub.DiscoverSchemasRequest_Mode" json:"mode,omitempty"`
	// The schemas to refresh if mode == 1.
	ToRefresh []*Schema `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 schemas.
	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 DiscoverSchemasRequest_Mode int32

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

type LogLevel int32

type OAuthConfiguration struct {
	// Client ID to use for resolving codes.
	ClientId string `protobuf:"bytes,1,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
	// Client secret to use for resolving codes.
	ClientSecret string `protobuf:"bytes,2,opt,name=client_secret,json=clientSecret,proto3" json:"client_secret,omitempty"`
	// The configuration blob stored for this plugin type,
	// which can contain any data that should not be hard coded into the plugin.
	ConfigurationJson    string   `protobuf:"bytes,3,opt,name=configuration_json,json=configurationJson,proto3" json:"configuration_json,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type PrepareWriteRequest struct {
	// Time in seconds that a record write back must be acknowledged by the plugin
	CommitSlaSeconds int32 `protobuf:"varint,1,opt,name=commit_sla_seconds,json=commitSlaSeconds,proto3" json:"commit_sla_seconds,omitempty"`
	// Schema to write back to source system
	Schema *Schema `protobuf:"bytes,2,opt,name=schema,proto3" json:"schema,omitempty"`
	// Replication information; if this is present, plugin should
	// prepare replication targets and expect incoming records to contain
	// replication data.
	Replication          *ReplicationWriteRequest `protobuf:"bytes,3,opt,name=replication,proto3" json:"replication,omitempty"`
	DataVersions         *DataVersions            `protobuf:"bytes,4,opt,name=data_versions,json=dataVersions,proto3" json:"data_versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                 `json:"-"`
	XXX_unrecognized     []byte                   `json:"-"`
	XXX_sizecache        int32                    `json:"-"`
}

type PrepareWriteResponse struct {
	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 schema.
	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 PublisherClient interface {
	// Configures the plugin.
	Configure(ctx context.Context, in *ConfigureRequest, opts ...grpc.CallOption) (*ConfigureResponse, error)
	// Instructs the plugin to connect to its data source.
	Connect(ctx context.Context, in *ConnectRequest, opts ...grpc.CallOption) (*ConnectResponse, error)
	// Instructs the plugin to connect to its data source
	// and maintain a session where any change in the connection state
	// or updates to OAuth information are streamed back to the host.
	// The plugin should maintain this connection until Disconnect is called.
	// This must be implemented if the plugin manifest has `canUseOAuth` set to
	// true.
	ConnectSession(ctx context.Context, in *ConnectRequest, opts ...grpc.CallOption) (Publisher_ConnectSessionClient, error)
	// DiscoverShapes requests a listing of schemas this publisher can provide
	// records for.
	//
	// Deprecated: Deprecated in API version 2. Implement DiscoverSchemasStream
	// instead.
	//
	// Deprecated: Do not use.
	DiscoverShapes(ctx context.Context, in *DiscoverSchemasRequest, opts ...grpc.CallOption) (*DiscoverSchemasResponse, error)
	// Requests a listing of schemas this publisher can provide records for.
	// New plugins should implement DiscoverSchemaStream and stream discovered
	// schemes to the caller.
	//
	// Deprecated: Deprecated in API version 2. Implement DiscoverSchemasStream
	// instead.
	DiscoverSchemas(ctx context.Context, in *DiscoverSchemasRequest, opts ...grpc.CallOption) (*DiscoverSchemasResponse, error)
	// Requests a stream of schemas this publisher can provide records for.
	//
	// API Version: 3
	DiscoverSchemasStream(ctx context.Context, in *DiscoverSchemasRequest, opts ...grpc.CallOption) (Publisher_DiscoverSchemasStreamClient, error)
	// PublishStream begins streaming records to the client from the plugin.
	// Implement ReadStream instead.
	//
	// Deprecated: Deprecated in API Version 2. Implement ReadStream instead.
	//
	// Deprecated: Do not use.
	PublishStream(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (Publisher_PublishStreamClient, error)
	// ReadStream begins streaming records to the client from the plugin.
	// API Version: 2
	ReadStream(ctx context.Context, in *ReadRequest, opts ...grpc.CallOption) (Publisher_ReadStreamClient, error)
	// Tells the plugin 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)
	// Configures a connection which can be used to connect to a data source.
	// This must be implemented if the plugin manifest has
	// `canConfigureConnection` set to true. This is an alternative to having a
	// `configSchema` element in the manifest.
	ConfigureConnection(ctx context.Context, in *ConfigureConnectionRequest, opts ...grpc.CallOption) (*ConfigureConnectionResponse, error)
	// Configures a query which can be used to publish a schema.
	// This must be implemented if the plugin manifest has `canConfigureQuery` set
	// to true.
	ConfigureQuery(ctx context.Context, in *ConfigureQueryRequest, opts ...grpc.CallOption) (*ConfigureQueryResponse, error)
	// Configures settings for real time publishing (change detection).
	// This must be implemented if the plugin manifest has `canPublishRealTime`
	// set to true.
	ConfigureRealTime(ctx context.Context, in *ConfigureRealTimeRequest, opts ...grpc.CallOption) (*ConfigureRealTimeResponse, error)
	// Invoked to begin an OAuth flow. This must be implemented if the plugin
	// manifest has `canUseOAuth` set to true.
	BeginOAuthFlow(ctx context.Context, in *BeginOAuthFlowRequest, opts ...grpc.CallOption) (*BeginOAuthFlowResponse, error)
	// Invoked to complete an OAuth flow. This must be implemented if the plugin
	// manifest has `canUseOAuth` set to true.
	CompleteOAuthFlow(ctx context.Context, in *CompleteOAuthFlowRequest, opts ...grpc.CallOption) (*CompleteOAuthFlowResponse, error)
	// Configures a write back which can be used to write back a schema to the
	// source. This must be implemented if the plugin manifest has
	// `canConfigureWrite` set to true.
	ConfigureWrite(ctx context.Context, in *ConfigureWriteRequest, opts ...grpc.CallOption) (*ConfigureWriteResponse, error)
	// Configures a replication write back, where the plugin is in control
	// of the destination and can insert/update/delete at will.
	ConfigureReplication(ctx context.Context, in *ConfigureReplicationRequest, opts ...grpc.CallOption) (*ConfigureReplicationResponse, error)
	// Invoked to begin a write back request
	// This must be implemented if the manifest has `canWrite` set to true.
	PrepareWrite(ctx context.Context, in *PrepareWriteRequest, opts ...grpc.CallOption) (*PrepareWriteResponse, error)
	// Creates a stream of records to write back and opens a stream to receive
	// acks for write backs This must be implemented if the manifest has
	// `canWrite` set to true.
	WriteStream(ctx context.Context, opts ...grpc.CallOption) (Publisher_WriteStreamClient, error)
	// Requests a listing of all related entities.
	DiscoverRelatedEntities(ctx context.Context, in *DiscoverRelatedEntitiesRequest, opts ...grpc.CallOption) (*DiscoverRelatedEntitiesResponse, error)
}

type PublisherServer interface {
	// Configures the plugin.
	Configure(context.Context, *ConfigureRequest) (*ConfigureResponse, error)
	// Instructs the plugin to connect to its data source.
	Connect(context.Context, *ConnectRequest) (*ConnectResponse, error)
	// Instructs the plugin to connect to its data source
	// and maintain a session where any change in the connection state
	// or updates to OAuth information are streamed back to the host.
	// The plugin should maintain this connection until Disconnect is called.
	// This must be implemented if the plugin manifest has `canUseOAuth` set to
	// true.
	ConnectSession(*ConnectRequest, Publisher_ConnectSessionServer) error
	// DiscoverShapes requests a listing of schemas this publisher can provide
	// records for.
	//
	// Deprecated: Deprecated in API version 2. Implement DiscoverSchemasStream
	// instead.
	//
	// Deprecated: Do not use.
	DiscoverShapes(context.Context, *DiscoverSchemasRequest) (*DiscoverSchemasResponse, error)
	// Requests a listing of schemas this publisher can provide records for.
	// New plugins should implement DiscoverSchemaStream and stream discovered
	// schemes to the caller.
	//
	// Deprecated: Deprecated in API version 2. Implement DiscoverSchemasStream
	// instead.
	DiscoverSchemas(context.Context, *DiscoverSchemasRequest) (*DiscoverSchemasResponse, error)
	// Requests a stream of schemas this publisher can provide records for.
	//
	// API Version: 3
	DiscoverSchemasStream(*DiscoverSchemasRequest, Publisher_DiscoverSchemasStreamServer) error
	// PublishStream begins streaming records to the client from the plugin.
	// Implement ReadStream instead.
	//
	// Deprecated: Deprecated in API Version 2. Implement ReadStream instead.
	//
	// Deprecated: Do not use.
	PublishStream(*ReadRequest, Publisher_PublishStreamServer) error
	// ReadStream begins streaming records to the client from the plugin.
	// API Version: 2
	ReadStream(*ReadRequest, Publisher_ReadStreamServer) error
	// Tells the plugin to disconnect from its data source, stop any running
	// publishes, and gracefully prepare to be shut down.
	Disconnect(context.Context, *DisconnectRequest) (*DisconnectResponse, error)
	// Configures a connection which can be used to connect to a data source.
	// This must be implemented if the plugin manifest has
	// `canConfigureConnection` set to true. This is an alternative to having a
	// `configSchema` element in the manifest.
	ConfigureConnection(context.Context, *ConfigureConnectionRequest) (*ConfigureConnectionResponse, error)
	// Configures a query which can be used to publish a schema.
	// This must be implemented if the plugin manifest has `canConfigureQuery` set
	// to true.
	ConfigureQuery(context.Context, *ConfigureQueryRequest) (*ConfigureQueryResponse, error)
	// Configures settings for real time publishing (change detection).
	// This must be implemented if the plugin manifest has `canPublishRealTime`
	// set to true.
	ConfigureRealTime(context.Context, *ConfigureRealTimeRequest) (*ConfigureRealTimeResponse, error)
	// Invoked to begin an OAuth flow. This must be implemented if the plugin
	// manifest has `canUseOAuth` set to true.
	BeginOAuthFlow(context.Context, *BeginOAuthFlowRequest) (*BeginOAuthFlowResponse, error)
	// Invoked to complete an OAuth flow. This must be implemented if the plugin
	// manifest has `canUseOAuth` set to true.
	CompleteOAuthFlow(context.Context, *CompleteOAuthFlowRequest) (*CompleteOAuthFlowResponse, error)
	// Configures a write back which can be used to write back a schema to the
	// source. This must be implemented if the plugin manifest has
	// `canConfigureWrite` set to true.
	ConfigureWrite(context.Context, *ConfigureWriteRequest) (*ConfigureWriteResponse, error)
	// Configures a replication write back, where the plugin is in control
	// of the destination and can insert/update/delete at will.
	ConfigureReplication(context.Context, *ConfigureReplicationRequest) (*ConfigureReplicationResponse, error)
	// Invoked to begin a write back request
	// This must be implemented if the manifest has `canWrite` set to true.
	PrepareWrite(context.Context, *PrepareWriteRequest) (*PrepareWriteResponse, error)
	// Creates a stream of records to write back and opens a stream to receive
	// acks for write backs This must be implemented if the manifest has
	// `canWrite` set to true.
	WriteStream(Publisher_WriteStreamServer) error
	// Requests a listing of all related entities.
	DiscoverRelatedEntities(context.Context, *DiscoverRelatedEntitiesRequest) (*DiscoverRelatedEntitiesResponse, error)
}

type Publisher_ConnectSessionClient interface {
	Recv() (*ConnectResponse, error)
	grpc.ClientStream
}

type Publisher_ConnectSessionServer interface {
	Send(*ConnectResponse) error
	grpc.ServerStream
}

type Publisher_DiscoverSchemasStreamClient interface {
	Recv() (*Schema, error)
	grpc.ClientStream
}

type Publisher_DiscoverSchemasStreamServer interface {
	Send(*Schema) error
	grpc.ServerStream
}

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

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

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

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

type Publisher_WriteStreamClient interface {
	Send(*Record) error
	Recv() (*RecordAck, error)
	grpc.ClientStream
}

type Publisher_WriteStreamServer interface {
	Send(*RecordAck) error
	Recv() (*Record, error)
	grpc.ServerStream
}

type ReadRequest struct {
	// The schema of the records to publish.
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,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"`
	// Settings for real time publishing, if any.
	RealTimeSettingsJson string `protobuf:"bytes,6,opt,name=real_time_settings_json,json=realTimeSettingsJson,proto3" json:"real_time_settings_json,omitempty"`
	// State object from the last published record from the
	// connection used for this publish request.
	RealTimeStateJson string `protobuf:"bytes,7,opt,name=real_time_state_json,json=realTimeStateJson,proto3" json:"real_time_state_json,omitempty"`
	// ID for the job which contains the schema, the connection used
	// to connect before starting this job, the real time settings and state,
	// and so on. Can be used to persist local state between publishes.
	JobId string `protobuf:"bytes,8,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// The data_version is a counter that will be incremented whenever
	// all data produced for a particular job_id should be discarded.
	//
	// Deprecated: Use the data_versions property instead.
	DataVersion          uint32        `protobuf:"varint,9,opt,name=data_version,json=dataVersion,proto3" json:"data_version,omitempty"`
	DataVersions         *DataVersions `protobuf:"bytes,10,opt,name=data_versions,json=dataVersions,proto3" json:"data_versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

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"`
	// State which should be preserved and passed back to the next
	// call of PublishStream. Only considered if action indicates this is a state
	// commit.
	RealTimeStateJson string `protobuf:"bytes,3,opt,name=real_time_state_json,json=realTimeStateJson,proto3" json:"real_time_state_json,omitempty"`
	// Cause for the publish of the record.
	// If provided, this should be an end-user readable string describing what
	// triggered the publish. This should only be set for real time published
	// records, where the cause may be interesting.
	Cause string `protobuf:"bytes,4,opt,name=cause,proto3" json:"cause,omitempty"`
	// Correlation ID for a record
	// Only expected to be used within the WriteStream method
	CorrelationId string `protobuf:"bytes,5,opt,name=correlation_id,json=correlationId,proto3" json:"correlation_id,omitempty"`
	// RecordID for the source record.
	// Only set on a replication writeback.
	RecordId string `protobuf:"bytes,6,opt,name=record_id,json=recordId,proto3" json:"record_id,omitempty"`
	// Versions of the record from other sources.
	// Only set on a replication writeback.
	Versions             []*RecordVersion `protobuf:"bytes,7,rep,name=versions,proto3" json:"versions,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

type RecordAck struct {
	// Correlation ID for record that has been written back
	CorrelationId string `protobuf:"bytes,1,opt,name=correlation_id,json=correlationId,proto3" json:"correlation_id,omitempty"`
	// Contains information about any error in writing back the record
	Error                string   `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type RecordVersion struct {
	// The connection than produced this version.
	ConnectionId string `protobuf:"bytes,1,opt,name=connection_id,json=connectionId,proto3" json:"connection_id,omitempty"`
	// The job that produced this version.
	JobId string `protobuf:"bytes,2,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// The schema that produced this version.
	SchemaId string `protobuf:"bytes,3,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// The RID of the original record for this version.
	RecordId string `protobuf:"bytes,4,opt,name=record_id,json=recordId,proto3" json:"record_id,omitempty"`
	// The shape data mapped from the schema data for this version.
	DataJson string `protobuf:"bytes,5,opt,name=data_json,json=dataJson,proto3" json:"data_json,omitempty"`
	// Any captured schema data for this version.
	SchemaDataJson       string   `protobuf:"bytes,6,opt,name=schema_data_json,json=schemaDataJson,proto3" json:"schema_data_json,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

type Record_Action int32

type RelatedEntity struct {
	// The source schema id that this applies to
	SchemaId string `protobuf:"bytes,1,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// The name of the source resource
	SourceResource string `protobuf:"bytes,2,opt,name=source_resource,json=sourceResource,proto3" json:"source_resource,omitempty"`
	// The name of the source column on the source resource
	SourceColumn string `protobuf:"bytes,3,opt,name=source_column,json=sourceColumn,proto3" json:"source_column,omitempty"`
	// The name of the foreign resource
	ForeignResource string `protobuf:"bytes,4,opt,name=foreign_resource,json=foreignResource,proto3" json:"foreign_resource,omitempty"`
	// The name of the foreign column on the foreign resource
	ForeignColumn string `protobuf:"bytes,5,opt,name=foreign_column,json=foreignColumn,proto3" json:"foreign_column,omitempty"`
	// The name of the type of relationship defined
	RelationshipName     string   `protobuf:"bytes,6,opt,name=relationship_name,json=relationshipName,proto3" json:"relationship_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}