v1

type AdapterClient interface {
	// Pulls the next page of objects from a datasource for an entity and its child entities.
	GetPage(ctx context.Context, in *GetPageRequest, opts ...grpc.CallOption) (*GetPageResponse, error)
}

type AdapterServer interface {
	// Pulls the next page of objects from a datasource for an entity and its child entities.
	GetPage(context.Context, *GetPageRequest) (*GetPageResponse, error)
	// contains filtered or unexported methods
}

type Attribute struct {

	// The unique identifier of the attribute.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The value(s) of the attribute.
	// May contain more than one value only if list is true.
	// If no value is given, the attribute's value is null.
	Values []*AttributeValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type AttributeConfig struct {

	// The unique identifier of the attribute.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The adapter-specific name of the attribute in the entity.
	ExternalId string `protobuf:"bytes,2,opt,name=external_id,json=externalId,proto3" json:"external_id,omitempty"`
	// The type of the ingested attribute's values.
	// Determines the field set in the returned AttributeValue for this
	// attribute.
	Type AttributeType `protobuf:"varint,3,opt,name=type,proto3,enum=sgnl.adapter.v1.AttributeType" json:"type,omitempty"`
	// Indicates whether the attribute contains a list of values vs. a single
	// value.
	List bool `protobuf:"varint,4,opt,name=list,proto3" json:"list,omitempty"`
	// Indicates whether the attribute represents a unique identifier for the entity.
	UniqueId bool `protobuf:"varint,5,opt,name=unique_id,json=uniqueId,proto3" json:"unique_id,omitempty"`
	// contains filtered or unexported fields
}

type AttributeType int32

type AttributeValue struct {

	// Types that are assignable to Value:
	//
	//	*AttributeValue_NullValue
	//	*AttributeValue_BoolValue
	//	*AttributeValue_DatetimeValue
	//	*AttributeValue_DoubleValue
	//	*AttributeValue_DurationValue
	//	*AttributeValue_Int64Value
	//	*AttributeValue_StringValue
	Value isAttributeValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

type AttributeValue_BoolValue struct {
	BoolValue bool `protobuf:"varint,2,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

type AttributeValue_DatetimeValue struct {
	DatetimeValue *DateTime `protobuf:"bytes,3,opt,name=datetime_value,json=datetimeValue,proto3,oneof"`
}

type AttributeValue_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,4,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type AttributeValue_DurationValue struct {
	DurationValue *Duration `protobuf:"bytes,5,opt,name=duration_value,json=durationValue,proto3,oneof"`
}

type AttributeValue_Int64Value struct {
	Int64Value int64 `protobuf:"varint,6,opt,name=int64_value,json=int64Value,proto3,oneof"`
}

type AttributeValue_NullValue struct {
	NullValue *emptypb.Empty `protobuf:"bytes,1,opt,name=null_value,json=nullValue,proto3,oneof"`
}

type AttributeValue_StringValue struct {
	StringValue string `protobuf:"bytes,7,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type DatasourceAuthCredentials struct {

	// The credentials to authenticate with the datasource.
	// Exactly one of these fields must be set.
	//
	// Types that are assignable to AuthMechanism:
	//
	//	*DatasourceAuthCredentials_Basic_
	//	*DatasourceAuthCredentials_HttpAuthorization
	AuthMechanism isDatasourceAuthCredentials_AuthMechanism `protobuf_oneof:"auth_mechanism"`
	// contains filtered or unexported fields
}

type DatasourceAuthCredentials_Basic struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

type DatasourceAuthCredentials_Basic_ struct {
	// Basic authentication credentials.
	Basic *DatasourceAuthCredentials_Basic `protobuf:"bytes,1,opt,name=basic,proto3,oneof"`
}

type DatasourceAuthCredentials_HttpAuthorization struct {
	// Credentials to be sent in an HTTP Authorization header.
	// Must be prefixed with the scheme, e.g. "Bearer".
	HttpAuthorization string `protobuf:"bytes,2,opt,name=http_authorization,json=httpAuthorization,proto3,oneof"`
}

type DatasourceConfig struct {

	// The unique identifier of the datasource.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The adapter-specific configuration for the datasource.
	// Optional.
	Config []byte `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// The address of the datasource.
	// Optional.
	Address string `protobuf:"bytes,3,opt,name=address,proto3" json:"address,omitempty"`
	// The credentials to use to authenticate with the datasource.
	// Optional.
	Auth *DatasourceAuthCredentials `protobuf:"bytes,4,opt,name=auth,proto3" json:"auth,omitempty"`
	// The type of the datasource. This can be used to route requests
	// on adapter deployments supporting multiple datasources.
	// If the adapter does not support this type, return an error.
	Type string `protobuf:"bytes,5,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

type DateTime struct {

	// The timestamp in the UTC timezone.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// The local timezone as its number of seconds east of UTC.
	// UTC if zero (default).
	TimezoneOffset int32 `protobuf:"varint,2,opt,name=timezone_offset,json=timezoneOffset,proto3" json:"timezone_offset,omitempty"`
	// contains filtered or unexported fields
}

type Duration struct {

	// A duration as a number of seconds.
	Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
	// A duration as a number of nanoseconds.
	Nanos int32 `protobuf:"varint,2,opt,name=nanos,proto3" json:"nanos,omitempty"`
	// A duration as a number of months.
	Months int64 `protobuf:"varint,3,opt,name=months,proto3" json:"months,omitempty"`
	// A duration as a number of days.
	Days int64 `protobuf:"varint,4,opt,name=days,proto3" json:"days,omitempty"`
	// contains filtered or unexported fields
}

type EntityConfig struct {

	// The unique identifier of the entity.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The adapter-specific name of the entity in the datasource.
	ExternalId string `protobuf:"bytes,2,opt,name=external_id,json=externalId,proto3" json:"external_id,omitempty"`
	// Indicates whether the objects are ordered by ID, i.e. whether the
	// response must contain objects ordered by monotonically increasing IDs for
	// the entity.
	Ordered bool `protobuf:"varint,3,opt,name=ordered,proto3" json:"ordered,omitempty"`
	// The configuration of the attributes to return for the entity.
	Attributes []*AttributeConfig `protobuf:"bytes,4,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// The configuration of the entities that are children of the entity
	// to return together with the entity.
	ChildEntities []*EntityConfig `protobuf:"bytes,5,rep,name=child_entities,json=childEntities,proto3" json:"child_entities,omitempty"`
	// contains filtered or unexported fields
}

type EntityObjects struct {

	// The ID of the entity the objects belong to.
	EntityId string `protobuf:"bytes,1,opt,name=entity_id,json=entityId,proto3" json:"entity_id,omitempty"`
	// The set of objects.
	Objects []*Object `protobuf:"bytes,2,rep,name=objects,proto3" json:"objects,omitempty"`
	// contains filtered or unexported fields
}

type Error struct {

	// The error message.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// The error code indicating the cause of the error.
	Code ErrorCode `protobuf:"varint,2,opt,name=code,proto3,enum=sgnl.adapter.v1.ErrorCode" json:"code,omitempty"`
	// Recommended minimal duration after which this request may be retried. Optional.
	RetryAfter *durationpb.Duration `protobuf:"bytes,3,opt,name=retry_after,json=retryAfter,proto3" json:"retry_after,omitempty"`
	// contains filtered or unexported fields
}

type ErrorCode int32

type GetPageRequest struct {

	// The datasource the entity belongs to.
	Datasource *DatasourceConfig `protobuf:"bytes,1,opt,name=datasource,proto3" json:"datasource,omitempty"`
	// The entity to return a page of objects from.
	Entity *EntityConfig `protobuf:"bytes,2,opt,name=entity,proto3" json:"entity,omitempty"`
	// The maximum number of objects to return from the entity.
	// The number of child_objects in each object is not limited:
	// all the objects from child entities are returned in each parent object.
	PageSize int64 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// The cursor that identifies the first object of the page to return, as
	// returned by the last call to GetPage for the entity.
	// If not set, return the first page for this entity.
	Cursor string `protobuf:"bytes,4,opt,name=cursor,proto3" json:"cursor,omitempty"`
	// contains filtered or unexported fields
}

type GetPageResponse struct {

	// Types that are assignable to Response:
	//
	//	*GetPageResponse_Success
	//	*GetPageResponse_Error
	Response isGetPageResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type GetPageResponse_Error struct {
	Error *Error `protobuf:"bytes,2,opt,name=error,proto3,oneof"`
}

type GetPageResponse_Success struct {
	Success *Page `protobuf:"bytes,1,opt,name=success,proto3,oneof"`
}

type Object struct {

	// The object's attributes.
	Attributes []*Attribute `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// The child objects that belong to child entities of
	// the object's entity.
	ChildObjects []*EntityObjects `protobuf:"bytes,2,rep,name=child_objects,json=childObjects,proto3" json:"child_objects,omitempty"`
	// contains filtered or unexported fields
}

type Page struct {

	// The set of objects in the page returned by the datasource for the
	// requested entity.
	// Up to page_size objects may be returned in this set.
	Objects []*Object `protobuf:"bytes,1,rep,name=objects,proto3" json:"objects,omitempty"`
	// The cursor that identifies the first object of the next page.
	// If not set, this page is the last page for this entity.
	NextCursor string `protobuf:"bytes,2,opt,name=next_cursor,json=nextCursor,proto3" json:"next_cursor,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedAdapterServer struct {
}

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