repository

package
v0.17.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2024 License: MIT Imports: 20 Imported by: 5

Documentation

Index

Constants

View Source 
const DocumentsPathPrefix = "/twirp/elephant.repository.Documents/"

DocumentsPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

View Source 
const MetricsPathPrefix = "/twirp/elephant.repository.Metrics/"

MetricsPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

View Source 
const ReportsPathPrefix = "/twirp/elephant.repository.Reports/"

ReportsPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

View Source 
const SchemasPathPrefix = "/twirp/elephant.repository.Schemas/"

SchemasPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

View Source 
const WorkflowsPathPrefix = "/twirp/elephant.repository.Workflows/"

WorkflowsPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

Variables

View Source 
var (
	GetMetaDoc_name = map[int32]string{
		0: "META_NONE",
		1: "META_INCLUDE",
		2: "META_ONLY",
	}
	GetMetaDoc_value = map[string]int32{
		"META_NONE":    0,
		"META_INCLUDE": 1,
		"META_ONLY":    2,
	}
)

Enum value maps for GetMetaDoc.

View Source 
var (
	MetricAggregation_name = map[int32]string{
		0: "NONE",
		1: "REPLACE",
		2: "INCREMENT",
	}
	MetricAggregation_value = map[string]int32{
		"NONE":      0,
		"REPLACE":   1,
		"INCREMENT": 2,
	}
)

Enum value maps for MetricAggregation.

View Source 
var File_repository_service_proto protoreflect.FileDescriptor

Functions

func WriteError 

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)

Types

type ACLEntry 

type ACLEntry struct {

	// URI that identifies the party that's granted access.
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// Permissions given to the grantee.
	Permissions []string `protobuf:"bytes,2,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// contains filtered or unexported fields
}

func (*ACLEntry) Descriptor deprecated 

func (*ACLEntry) Descriptor() ([]byte, []int)

Deprecated: Use ACLEntry.ProtoReflect.Descriptor instead.

func (*ACLEntry) GetPermissions 

func (x *ACLEntry) GetPermissions() []string

func (*ACLEntry) GetUri 

func (x *ACLEntry) GetUri() string

func (*ACLEntry) ProtoMessage 

func (*ACLEntry) ProtoMessage()

func (*ACLEntry) ProtoReflect 

func (x *ACLEntry) ProtoReflect() protoreflect.Message

func (*ACLEntry) Reset 

func (x *ACLEntry) Reset()

func (*ACLEntry) String 

func (x *ACLEntry) String() string

type BulkGetItem added in v0.15.0 

type BulkGetItem struct {

	// Document is the requested document.
	Document *newsdoc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Version is the version of the returned document.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkGetItem) Descriptor deprecated added in v0.15.0 

func (*BulkGetItem) Descriptor() ([]byte, []int)

Deprecated: Use BulkGetItem.ProtoReflect.Descriptor instead.

func (*BulkGetItem) GetDocument added in v0.15.0 

func (x *BulkGetItem) GetDocument() *newsdoc.Document

func (*BulkGetItem) GetVersion added in v0.15.0 

func (x *BulkGetItem) GetVersion() int64

func (*BulkGetItem) ProtoMessage added in v0.15.0 

func (*BulkGetItem) ProtoMessage()

func (*BulkGetItem) ProtoReflect added in v0.15.0 

func (x *BulkGetItem) ProtoReflect() protoreflect.Message

func (*BulkGetItem) Reset added in v0.15.0 

func (x *BulkGetItem) Reset()

func (*BulkGetItem) String added in v0.15.0 

func (x *BulkGetItem) String() string

type BulkGetReference added in v0.15.0 

type BulkGetReference struct {

	// UUID of the document to get.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Version to get, omit to get latest.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkGetReference) Descriptor deprecated added in v0.15.0 

func (*BulkGetReference) Descriptor() ([]byte, []int)

Deprecated: Use BulkGetReference.ProtoReflect.Descriptor instead.

func (*BulkGetReference) GetUuid added in v0.15.0 

func (x *BulkGetReference) GetUuid() string

func (*BulkGetReference) GetVersion added in v0.15.0 

func (x *BulkGetReference) GetVersion() int64

func (*BulkGetReference) ProtoMessage added in v0.15.0 

func (*BulkGetReference) ProtoMessage()

func (*BulkGetReference) ProtoReflect added in v0.15.0 

func (x *BulkGetReference) ProtoReflect() protoreflect.Message

func (*BulkGetReference) Reset added in v0.15.0 

func (x *BulkGetReference) Reset()

func (*BulkGetReference) String added in v0.15.0 

func (x *BulkGetReference) String() string

type BulkGetRequest added in v0.15.0 

type BulkGetRequest struct {

	// Documents to get.
	Documents []*BulkGetReference `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkGetRequest) Descriptor deprecated added in v0.15.0 

func (*BulkGetRequest) Descriptor() ([]byte, []int)

Deprecated: Use BulkGetRequest.ProtoReflect.Descriptor instead.

func (*BulkGetRequest) GetDocuments added in v0.15.0 

func (x *BulkGetRequest) GetDocuments() []*BulkGetReference

func (*BulkGetRequest) ProtoMessage added in v0.15.0 

func (*BulkGetRequest) ProtoMessage()

func (*BulkGetRequest) ProtoReflect added in v0.15.0 

func (x *BulkGetRequest) ProtoReflect() protoreflect.Message

func (*BulkGetRequest) Reset added in v0.15.0 

func (x *BulkGetRequest) Reset()

func (*BulkGetRequest) String added in v0.15.0 

func (x *BulkGetRequest) String() string

type BulkGetResponse added in v0.15.0 

type BulkGetResponse struct {
	Items []*BulkGetItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkGetResponse) Descriptor deprecated added in v0.15.0 

func (*BulkGetResponse) Descriptor() ([]byte, []int)

Deprecated: Use BulkGetResponse.ProtoReflect.Descriptor instead.

func (*BulkGetResponse) GetItems added in v0.15.0 

func (x *BulkGetResponse) GetItems() []*BulkGetItem

func (*BulkGetResponse) ProtoMessage added in v0.15.0 

func (*BulkGetResponse) ProtoMessage()

func (*BulkGetResponse) ProtoReflect added in v0.15.0 

func (x *BulkGetResponse) ProtoReflect() protoreflect.Message

func (*BulkGetResponse) Reset added in v0.15.0 

func (x *BulkGetResponse) Reset()

func (*BulkGetResponse) String added in v0.15.0 

func (x *BulkGetResponse) String() string

type BulkUpdateRequest added in v0.7.0 

type BulkUpdateRequest struct {
	Updates []*UpdateRequest `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkUpdateRequest) Descriptor deprecated added in v0.7.0 

func (*BulkUpdateRequest) Descriptor() ([]byte, []int)

Deprecated: Use BulkUpdateRequest.ProtoReflect.Descriptor instead.

func (*BulkUpdateRequest) GetUpdates added in v0.7.0 

func (x *BulkUpdateRequest) GetUpdates() []*UpdateRequest

func (*BulkUpdateRequest) ProtoMessage added in v0.7.0 

func (*BulkUpdateRequest) ProtoMessage()

func (*BulkUpdateRequest) ProtoReflect added in v0.7.0 

func (x *BulkUpdateRequest) ProtoReflect() protoreflect.Message

func (*BulkUpdateRequest) Reset added in v0.7.0 

func (x *BulkUpdateRequest) Reset()

func (*BulkUpdateRequest) String added in v0.7.0 

func (x *BulkUpdateRequest) String() string

type BulkUpdateResponse added in v0.7.0 

type BulkUpdateResponse struct {
	Updates []*UpdateResponse `protobuf:"bytes,1,rep,name=updates,proto3" json:"updates,omitempty"`
	// contains filtered or unexported fields
}

func (*BulkUpdateResponse) Descriptor deprecated added in v0.7.0 

func (*BulkUpdateResponse) Descriptor() ([]byte, []int)

Deprecated: Use BulkUpdateResponse.ProtoReflect.Descriptor instead.

func (*BulkUpdateResponse) GetUpdates added in v0.10.0 

func (x *BulkUpdateResponse) GetUpdates() []*UpdateResponse

func (*BulkUpdateResponse) ProtoMessage added in v0.7.0 

func (*BulkUpdateResponse) ProtoMessage()

func (*BulkUpdateResponse) ProtoReflect added in v0.7.0 

func (x *BulkUpdateResponse) ProtoReflect() protoreflect.Message

func (*BulkUpdateResponse) Reset added in v0.7.0 

func (x *BulkUpdateResponse) Reset()

func (*BulkUpdateResponse) String added in v0.7.0 

func (x *BulkUpdateResponse) String() string

type CreateStatusRuleRequest 

type CreateStatusRuleRequest struct {
	Rule *StatusRule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateStatusRuleRequest) Descriptor deprecated 

func (*CreateStatusRuleRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateStatusRuleRequest.ProtoReflect.Descriptor instead.

func (*CreateStatusRuleRequest) GetRule 

func (x *CreateStatusRuleRequest) GetRule() *StatusRule

func (*CreateStatusRuleRequest) ProtoMessage 

func (*CreateStatusRuleRequest) ProtoMessage()

func (*CreateStatusRuleRequest) ProtoReflect 

func (x *CreateStatusRuleRequest) ProtoReflect() protoreflect.Message

func (*CreateStatusRuleRequest) Reset 

func (x *CreateStatusRuleRequest) Reset()

func (*CreateStatusRuleRequest) String 

func (x *CreateStatusRuleRequest) String() string

type CreateStatusRuleResponse 

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

func (*CreateStatusRuleResponse) Descriptor deprecated 

func (*CreateStatusRuleResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateStatusRuleResponse.ProtoReflect.Descriptor instead.

func (*CreateStatusRuleResponse) ProtoMessage 

func (*CreateStatusRuleResponse) ProtoMessage()

func (*CreateStatusRuleResponse) ProtoReflect 

func (x *CreateStatusRuleResponse) ProtoReflect() protoreflect.Message

func (*CreateStatusRuleResponse) Reset 

func (x *CreateStatusRuleResponse) Reset()

func (*CreateStatusRuleResponse) String 

func (x *CreateStatusRuleResponse) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

	// UUID of the document to delete.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Meta data to include with the delete record.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// IfMatch is used for optimistic locks. Set to the version that you require
	// to be the current one for the delete to be performed.
	IfMatch int64 `protobuf:"varint,3,opt,name=if_match,json=ifMatch,proto3" json:"if_match,omitempty"`
	// LockToken is used for explicit pessimistic locking.
	LockToken string `protobuf:"bytes,8,opt,name=lockToken,proto3" json:"lockToken,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteDocumentRequest) Descriptor deprecated 

func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetIfMatch 

func (x *DeleteDocumentRequest) GetIfMatch() int64

func (*DeleteDocumentRequest) GetLockToken added in v0.6.0 

func (x *DeleteDocumentRequest) GetLockToken() string

func (*DeleteDocumentRequest) GetMeta 

func (x *DeleteDocumentRequest) GetMeta() map[string]string

func (*DeleteDocumentRequest) GetUuid 

func (x *DeleteDocumentRequest) GetUuid() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteDocumentResponse 

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

func (*DeleteDocumentResponse) Descriptor deprecated 

func (*DeleteDocumentResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDocumentResponse.ProtoReflect.Descriptor instead.

func (*DeleteDocumentResponse) ProtoMessage 

func (*DeleteDocumentResponse) ProtoMessage()

func (*DeleteDocumentResponse) ProtoReflect 

func (x *DeleteDocumentResponse) ProtoReflect() protoreflect.Message

func (*DeleteDocumentResponse) Reset 

func (x *DeleteDocumentResponse) Reset()

func (*DeleteDocumentResponse) String 

func (x *DeleteDocumentResponse) String() string

type DeleteMetricKindRequest 

type DeleteMetricKindRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteMetricKindRequest) Descriptor deprecated 

func (*DeleteMetricKindRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteMetricKindRequest.ProtoReflect.Descriptor instead.

func (*DeleteMetricKindRequest) GetName 

func (x *DeleteMetricKindRequest) GetName() string

func (*DeleteMetricKindRequest) ProtoMessage 

func (*DeleteMetricKindRequest) ProtoMessage()

func (*DeleteMetricKindRequest) ProtoReflect 

func (x *DeleteMetricKindRequest) ProtoReflect() protoreflect.Message

func (*DeleteMetricKindRequest) Reset 

func (x *DeleteMetricKindRequest) Reset()

func (*DeleteMetricKindRequest) String 

func (x *DeleteMetricKindRequest) String() string

type DeleteMetricKindResponse 

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

func (*DeleteMetricKindResponse) Descriptor deprecated 

func (*DeleteMetricKindResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteMetricKindResponse.ProtoReflect.Descriptor instead.

func (*DeleteMetricKindResponse) ProtoMessage 

func (*DeleteMetricKindResponse) ProtoMessage()

func (*DeleteMetricKindResponse) ProtoReflect 

func (x *DeleteMetricKindResponse) ProtoReflect() protoreflect.Message

func (*DeleteMetricKindResponse) Reset 

func (x *DeleteMetricKindResponse) Reset()

func (*DeleteMetricKindResponse) String 

func (x *DeleteMetricKindResponse) String() string

type DeleteRecord added in v0.13.0 

type DeleteRecord struct {

	// ID of the delete record.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// UUID of the document.
	Uuid string `protobuf:"bytes,2,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// URI of the document.
	Uri string `protobuf:"bytes,3,opt,name=uri,proto3" json:"uri,omitempty"`
	// Type of the document.
	Type string `protobuf:"bytes,4,opt,name=type,proto3" json:"type,omitempty"`
	// Version that the document had at the time of restore.
	Version int64 `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	// Creation time for the delete record, as an RFC3339 timestamp.
	Created string `protobuf:"bytes,6,opt,name=created,proto3" json:"created,omitempty"`
	// Creator of the delete record.
	Creator string `protobuf:"bytes,7,opt,name=creator,proto3" json:"creator,omitempty"`
	// Meta data included with the delete record.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// Language that the document was in.
	Language string `protobuf:"bytes,9,opt,name=language,proto3" json:"language,omitempty"`
	// Finalised is the time, as an RFC3339 timestamp, that the document finished
	// deleting. Empty if the delete is in progress.
	Finalised string `protobuf:"bytes,10,opt,name=finalised,proto3" json:"finalised,omitempty"`
	// Purged is the time, as an RFC3339 timestamp, all archived data for the
	// document was purged. Empty if the document hasn't been purged.
	Purged string `protobuf:"bytes,11,opt,name=purged,proto3" json:"purged,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteRecord) Descriptor deprecated added in v0.13.0 

func (*DeleteRecord) Descriptor() ([]byte, []int)

Deprecated: Use DeleteRecord.ProtoReflect.Descriptor instead.

func (*DeleteRecord) GetCreated added in v0.13.0 

func (x *DeleteRecord) GetCreated() string

func (*DeleteRecord) GetCreator added in v0.13.0 

func (x *DeleteRecord) GetCreator() string

func (*DeleteRecord) GetFinalised added in v0.13.0 

func (x *DeleteRecord) GetFinalised() string

func (*DeleteRecord) GetId added in v0.13.0 

func (x *DeleteRecord) GetId() int64

func (*DeleteRecord) GetLanguage added in v0.13.0 

func (x *DeleteRecord) GetLanguage() string

func (*DeleteRecord) GetMeta added in v0.13.0 

func (x *DeleteRecord) GetMeta() map[string]string

func (*DeleteRecord) GetPurged added in v0.13.0 

func (x *DeleteRecord) GetPurged() string

func (*DeleteRecord) GetType added in v0.13.0 

func (x *DeleteRecord) GetType() string

func (*DeleteRecord) GetUri added in v0.13.0 

func (x *DeleteRecord) GetUri() string

func (*DeleteRecord) GetUuid added in v0.13.0 

func (x *DeleteRecord) GetUuid() string

func (*DeleteRecord) GetVersion added in v0.13.0 

func (x *DeleteRecord) GetVersion() int64

func (*DeleteRecord) ProtoMessage added in v0.13.0 

func (*DeleteRecord) ProtoMessage()

func (*DeleteRecord) ProtoReflect added in v0.13.0 

func (x *DeleteRecord) ProtoReflect() protoreflect.Message

func (*DeleteRecord) Reset added in v0.13.0 

func (x *DeleteRecord) Reset()

func (*DeleteRecord) String added in v0.13.0 

func (x *DeleteRecord) String() string

type DeleteReportRequest added in v0.9.0 

type DeleteReportRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteReportRequest) Descriptor deprecated added in v0.9.0 

func (*DeleteReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteReportRequest.ProtoReflect.Descriptor instead.

func (*DeleteReportRequest) GetName added in v0.9.0 

func (x *DeleteReportRequest) GetName() string

func (*DeleteReportRequest) ProtoMessage added in v0.9.0 

func (*DeleteReportRequest) ProtoMessage()

func (*DeleteReportRequest) ProtoReflect added in v0.9.0 

func (x *DeleteReportRequest) ProtoReflect() protoreflect.Message

func (*DeleteReportRequest) Reset added in v0.9.0 

func (x *DeleteReportRequest) Reset()

func (*DeleteReportRequest) String added in v0.9.0 

func (x *DeleteReportRequest) String() string

type DeleteReportResponse added in v0.9.0 

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

func (*DeleteReportResponse) Descriptor deprecated added in v0.9.0 

func (*DeleteReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteReportResponse.ProtoReflect.Descriptor instead.

func (*DeleteReportResponse) ProtoMessage added in v0.9.0 

func (*DeleteReportResponse) ProtoMessage()

func (*DeleteReportResponse) ProtoReflect added in v0.9.0 

func (x *DeleteReportResponse) ProtoReflect() protoreflect.Message

func (*DeleteReportResponse) Reset added in v0.9.0 

func (x *DeleteReportResponse) Reset()

func (*DeleteReportResponse) String added in v0.9.0 

func (x *DeleteReportResponse) String() string

type DeleteStatusRuleRequest 

type DeleteStatusRuleRequest struct {
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteStatusRuleRequest) Descriptor deprecated 

func (*DeleteStatusRuleRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteStatusRuleRequest.ProtoReflect.Descriptor instead.

func (*DeleteStatusRuleRequest) GetName 

func (x *DeleteStatusRuleRequest) GetName() string

func (*DeleteStatusRuleRequest) GetType added in v0.16.0 

func (x *DeleteStatusRuleRequest) GetType() string

func (*DeleteStatusRuleRequest) ProtoMessage 

func (*DeleteStatusRuleRequest) ProtoMessage()

func (*DeleteStatusRuleRequest) ProtoReflect 

func (x *DeleteStatusRuleRequest) ProtoReflect() protoreflect.Message

func (*DeleteStatusRuleRequest) Reset 

func (x *DeleteStatusRuleRequest) Reset()

func (*DeleteStatusRuleRequest) String 

func (x *DeleteStatusRuleRequest) String() string

type DeleteStatusRuleResponse 

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

func (*DeleteStatusRuleResponse) Descriptor deprecated 

func (*DeleteStatusRuleResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteStatusRuleResponse.ProtoReflect.Descriptor instead.

func (*DeleteStatusRuleResponse) ProtoMessage 

func (*DeleteStatusRuleResponse) ProtoMessage()

func (*DeleteStatusRuleResponse) ProtoReflect 

func (x *DeleteStatusRuleResponse) ProtoReflect() protoreflect.Message

func (*DeleteStatusRuleResponse) Reset 

func (x *DeleteStatusRuleResponse) Reset()

func (*DeleteStatusRuleResponse) String 

func (x *DeleteStatusRuleResponse) String() string

type Deprecation added in v0.11.0 

type Deprecation struct {
	Label    string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	Enforced bool   `protobuf:"varint,2,opt,name=enforced,proto3" json:"enforced,omitempty"`
	// contains filtered or unexported fields
}

func (*Deprecation) Descriptor deprecated added in v0.11.0 

func (*Deprecation) Descriptor() ([]byte, []int)

Deprecated: Use Deprecation.ProtoReflect.Descriptor instead.

func (*Deprecation) GetEnforced added in v0.11.0 

func (x *Deprecation) GetEnforced() bool

func (*Deprecation) GetLabel added in v0.11.0 

func (x *Deprecation) GetLabel() string

func (*Deprecation) ProtoMessage added in v0.11.0 

func (*Deprecation) ProtoMessage()

func (*Deprecation) ProtoReflect added in v0.11.0 

func (x *Deprecation) ProtoReflect() protoreflect.Message

func (*Deprecation) Reset added in v0.11.0 

func (x *Deprecation) Reset()

func (*Deprecation) String added in v0.11.0 

func (x *Deprecation) String() string

type DocumentMeta 

type DocumentMeta struct {

	// Created timestamp is the RFC3339 timestamp for when the document was
	// created.
	Created string `protobuf:"bytes,1,opt,name=created,proto3" json:"created,omitempty"`
	// Modified timestamp is the RFC3339 timestamp for the last change that
	// affected the document.
	Modified string `protobuf:"bytes,2,opt,name=modified,proto3" json:"modified,omitempty"`
	// CurrentVersion is the last written version of the document.
	CurrentVersion int64 `protobuf:"varint,3,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"`
	// Heads are the last statuses.
	Heads map[string]*Status `` /* 151-byte string literal not displayed */
	// ACL is an ACL list controlling access to the document.
	Acl []*ACLEntry `protobuf:"bytes,5,rep,name=acl,proto3" json:"acl,omitempty"`
	// Document lock, if any
	Lock *Lock `protobuf:"bytes,6,opt,name=lock,proto3" json:"lock,omitempty"`
	// IsMetaDocument is true if the document is a meta document.
	IsMetaDocument bool `protobuf:"varint,7,opt,name=is_meta_document,json=isMetaDocument,proto3" json:"is_meta_document,omitempty"`
	// MainDocument is the UUID of the main document if this is a meta document.
	MainDocument string `protobuf:"bytes,8,opt,name=main_document,json=mainDocument,proto3" json:"main_document,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentMeta) Descriptor deprecated 

func (*DocumentMeta) Descriptor() ([]byte, []int)

Deprecated: Use DocumentMeta.ProtoReflect.Descriptor instead.

func (*DocumentMeta) GetAcl 

func (x *DocumentMeta) GetAcl() []*ACLEntry

func (*DocumentMeta) GetCreated 

func (x *DocumentMeta) GetCreated() string

func (*DocumentMeta) GetCurrentVersion 

func (x *DocumentMeta) GetCurrentVersion() int64

func (*DocumentMeta) GetHeads 

func (x *DocumentMeta) GetHeads() map[string]*Status

func (*DocumentMeta) GetIsMetaDocument added in v0.10.0 

func (x *DocumentMeta) GetIsMetaDocument() bool

func (*DocumentMeta) GetLock added in v0.6.0 

func (x *DocumentMeta) GetLock() *Lock

func (*DocumentMeta) GetMainDocument added in v0.10.0 

func (x *DocumentMeta) GetMainDocument() string

func (*DocumentMeta) GetModified 

func (x *DocumentMeta) GetModified() string

func (*DocumentMeta) ProtoMessage 

func (*DocumentMeta) ProtoMessage()

func (*DocumentMeta) ProtoReflect 

func (x *DocumentMeta) ProtoReflect() protoreflect.Message

func (*DocumentMeta) Reset 

func (x *DocumentMeta) Reset()

func (*DocumentMeta) String 

func (x *DocumentMeta) String() string

type DocumentVersion 

type DocumentVersion struct {

	// Version of the document.
	Version int64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// Created timestamp is the RFC3339 timestamp for when the version was
	// created.
	Created string `protobuf:"bytes,2,opt,name=created,proto3" json:"created,omitempty"`
	// Creator of the version.
	Creator string `protobuf:"bytes,3,opt,name=creator,proto3" json:"creator,omitempty"`
	// Meta data to for the document version.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DocumentVersion) Descriptor deprecated 

func (*DocumentVersion) Descriptor() ([]byte, []int)

Deprecated: Use DocumentVersion.ProtoReflect.Descriptor instead.

func (*DocumentVersion) GetCreated 

func (x *DocumentVersion) GetCreated() string

func (*DocumentVersion) GetCreator 

func (x *DocumentVersion) GetCreator() string

func (*DocumentVersion) GetMeta 

func (x *DocumentVersion) GetMeta() map[string]string

func (*DocumentVersion) GetVersion 

func (x *DocumentVersion) GetVersion() int64

func (*DocumentVersion) ProtoMessage 

func (*DocumentVersion) ProtoMessage()

func (*DocumentVersion) ProtoReflect 

func (x *DocumentVersion) ProtoReflect() protoreflect.Message

func (*DocumentVersion) Reset 

func (x *DocumentVersion) Reset()

func (*DocumentVersion) String 

func (x *DocumentVersion) String() string

type Documents 

type Documents interface {
	// Get retrieves a document version.
	Get(context.Context, *GetDocumentRequest) (*GetDocumentResponse, error)

	// BulkGet loads multiple documents in a single request.
	BulkGet(context.Context, *BulkGetRequest) (*BulkGetResponse, error)

	// GetHistory lists the document version history.
	GetHistory(context.Context, *GetHistoryRequest) (*GetHistoryResponse, error)

	// Update is used to create new document versions, set statuses, update ACLs.
	Update(context.Context, *UpdateRequest) (*UpdateResponse, error)

	// BulkUpdate is used to create new document versions, set statuses, update ACLs.
	BulkUpdate(context.Context, *BulkUpdateRequest) (*BulkUpdateResponse, error)

	// Validate is used to validate a document without writing it to the
	// repository.
	Validate(context.Context, *ValidateRequest) (*ValidateResponse, error)

	// Delete deletes a document and all its associated data.
	Delete(context.Context, *DeleteDocumentRequest) (*DeleteDocumentResponse, error)

	// ListDeleted lists deleted document instances for a UUID.
	ListDeleted(context.Context, *ListDeletedRequest) (*ListDeletedResponse, error)

	// Restore recovers a deleted document.
	Restore(context.Context, *RestoreRequest) (*RestoreResponse, error)

	// Purge removes a deleted document completely.
	Purge(context.Context, *PurgeRequest) (*PurgeResponse, error)

	// GetMeta returns metadata for a document, including the ACL and current
	// status heads.
	GetMeta(context.Context, *GetMetaRequest) (*GetMetaResponse, error)

	// Eventlog returns document update events, optionally waiting for new events.
	Eventlog(context.Context, *GetEventlogRequest) (*GetEventlogResponse, error)

	// CompactedEventlog returns document update events. If more than one event
	// has occured for a document in the given window only the latest will be returned.
	CompactedEventlog(context.Context, *GetCompactedEventlogRequest) (*GetCompactedEventlogResponse, error)

	// GetStatus returns a single status.
	GetStatus(context.Context, *GetStatusRequest) (*GetStatusResponse, error)

	// GetStatusHistory returns the history of a status for a document.
	GetStatusHistory(context.Context, *GetStatusHistoryRequest) (*GetStatusHistoryReponse, error)

	// GetStatusOverview returns the current version and a set of statuses for a
	// gven list of documents.
	GetStatusOverview(context.Context, *GetStatusOverviewRequest) (*GetStatusOverviewResponse, error)

	// GetPermissions returns the permissions you have for the document.
	GetPermissions(context.Context, *GetPermissionsRequest) (*GetPermissionsResponse, error)

	// Lock attempts to acquire a write lock on a document.
	Lock(context.Context, *LockRequest) (*LockResponse, error)

	// ExtendLock extends the expiration of an existing lock.
	ExtendLock(context.Context, *ExtendLockRequest) (*LockResponse, error)

	// Unlock releases a write lock on a document.
	Unlock(context.Context, *UnlockRequest) (*UnlockResponse, error)
}

func NewDocumentsJSONClient 

func NewDocumentsJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Documents

NewDocumentsJSONClient creates a JSON client that implements the Documents interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewDocumentsProtobufClient 

func NewDocumentsProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Documents

NewDocumentsProtobufClient creates a Protobuf client that implements the Documents interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type EntityRef 

type EntityRef struct {

	// RefType is type of entity that's referenced, one of "block", "property",
	// "attribute", "data attribute", or "parameter."
	RefType string `protobuf:"bytes,1,opt,name=ref_type,json=refType,proto3" json:"ref_type,omitempty"`
	// Kind is the block type, one of "link", "meta", or "content".
	Kind string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	// Index is the position of the entity in an array, where applicable.
	Index int64 `protobuf:"varint,3,opt,name=index,proto3" json:"index,omitempty"`
	// Name is the name of the entity, where applicable.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// Type is the type of the entity, where applicable.
	Type string `protobuf:"bytes,5,opt,name=type,proto3" json:"type,omitempty"`
	// Rel is the relationship for the entity, where applicable.
	Rel string `protobuf:"bytes,6,opt,name=rel,proto3" json:"rel,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityRef) Descriptor deprecated 

func (*EntityRef) Descriptor() ([]byte, []int)

Deprecated: Use EntityRef.ProtoReflect.Descriptor instead.

func (*EntityRef) GetIndex 

func (x *EntityRef) GetIndex() int64

func (*EntityRef) GetKind 

func (x *EntityRef) GetKind() string

func (*EntityRef) GetName 

func (x *EntityRef) GetName() string

func (*EntityRef) GetRefType 

func (x *EntityRef) GetRefType() string

func (*EntityRef) GetRel 

func (x *EntityRef) GetRel() string

func (*EntityRef) GetType 

func (x *EntityRef) GetType() string

func (*EntityRef) ProtoMessage 

func (*EntityRef) ProtoMessage()

func (*EntityRef) ProtoReflect 

func (x *EntityRef) ProtoReflect() protoreflect.Message

func (*EntityRef) Reset 

func (x *EntityRef) Reset()

func (*EntityRef) String 

func (x *EntityRef) String() string

type EventlogItem 

type EventlogItem struct {

	// Id of the event.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Event type, one of: "document", "status", "acl", "delete_document",
	// "restore_finished".
	Event string `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// Uuid of the document that was affected.
	Uuid string `protobuf:"bytes,3,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Timestamp that the event occurred, as an RFC3339 timestamp.
	Timestamp string `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Version of the document.
	Version int64 `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	// Status that was affected, if it was a "status" event.
	Status string `protobuf:"bytes,6,opt,name=status,proto3" json:"status,omitempty"`
	// StatusId is the ID of the created status.
	StatusId int64 `protobuf:"varint,7,opt,name=status_id,json=statusId,proto3" json:"status_id,omitempty"`
	// Acl entry, if it was an "acl" event.
	Acl []*ACLEntry `protobuf:"bytes,8,rep,name=acl,proto3" json:"acl,omitempty"`
	// UpdaterUri is the URI for the subject that performed the update.
	UpdaterUri string `protobuf:"bytes,9,opt,name=updater_uri,json=updaterUri,proto3" json:"updater_uri,omitempty"`
	// Type of the affected document.
	Type string `protobuf:"bytes,10,opt,name=type,proto3" json:"type,omitempty"`
	// Language of the affected document.
	Language string `protobuf:"bytes,11,opt,name=language,proto3" json:"language,omitempty"`
	// OldLanguage of the document if the document changed language.
	OldLanguage string `protobuf:"bytes,12,opt,name=old_language,json=oldLanguage,proto3" json:"old_language,omitempty"`
	// MainDocument UUID if the document is a metadata document.
	MainDocument string `protobuf:"bytes,13,opt,name=main_document,json=mainDocument,proto3" json:"main_document,omitempty"`
	// SystemState is set to "restoring" if this event was generated from a
	// restore operation. If the event wasn't generated by a special operation it
	// is left empty.
	SystemState string `protobuf:"bytes,14,opt,name=system_state,json=systemState,proto3" json:"system_state,omitempty"`
	// contains filtered or unexported fields
}

func (*EventlogItem) Descriptor deprecated 

func (*EventlogItem) Descriptor() ([]byte, []int)

Deprecated: Use EventlogItem.ProtoReflect.Descriptor instead.

func (*EventlogItem) GetAcl 

func (x *EventlogItem) GetAcl() []*ACLEntry

func (*EventlogItem) GetEvent 

func (x *EventlogItem) GetEvent() string

func (*EventlogItem) GetId 

func (x *EventlogItem) GetId() int64

func (*EventlogItem) GetLanguage added in v0.10.0 

func (x *EventlogItem) GetLanguage() string

func (*EventlogItem) GetMainDocument added in v0.10.0 

func (x *EventlogItem) GetMainDocument() string

func (*EventlogItem) GetOldLanguage added in v0.10.0 

func (x *EventlogItem) GetOldLanguage() string

func (*EventlogItem) GetStatus 

func (x *EventlogItem) GetStatus() string

func (*EventlogItem) GetStatusId 

func (x *EventlogItem) GetStatusId() int64

func (*EventlogItem) GetSystemState added in v0.13.0 

func (x *EventlogItem) GetSystemState() string

func (*EventlogItem) GetTimestamp 

func (x *EventlogItem) GetTimestamp() string

func (*EventlogItem) GetType 

func (x *EventlogItem) GetType() string

func (*EventlogItem) GetUpdaterUri 

func (x *EventlogItem) GetUpdaterUri() string

func (*EventlogItem) GetUuid 

func (x *EventlogItem) GetUuid() string

func (*EventlogItem) GetVersion 

func (x *EventlogItem) GetVersion() int64

func (*EventlogItem) ProtoMessage 

func (*EventlogItem) ProtoMessage()

func (*EventlogItem) ProtoReflect 

func (x *EventlogItem) ProtoReflect() protoreflect.Message

func (*EventlogItem) Reset 

func (x *EventlogItem) Reset()

func (*EventlogItem) String 

func (x *EventlogItem) String() string

type ExtendLockRequest added in v0.6.0 

type ExtendLockRequest struct {

	// UUID of the document to extend the lock for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Lock TTL in milliseconds.
	Ttl int32 `protobuf:"varint,2,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Lock token in UUID format.
	Token string `protobuf:"bytes,3,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*ExtendLockRequest) Descriptor deprecated added in v0.6.0 

func (*ExtendLockRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExtendLockRequest.ProtoReflect.Descriptor instead.

func (*ExtendLockRequest) GetToken added in v0.6.0 

func (x *ExtendLockRequest) GetToken() string

func (*ExtendLockRequest) GetTtl added in v0.6.0 

func (x *ExtendLockRequest) GetTtl() int32

func (*ExtendLockRequest) GetUuid added in v0.6.0 

func (x *ExtendLockRequest) GetUuid() string

func (*ExtendLockRequest) ProtoMessage added in v0.6.0 

func (*ExtendLockRequest) ProtoMessage()

func (*ExtendLockRequest) ProtoReflect added in v0.6.0 

func (x *ExtendLockRequest) ProtoReflect() protoreflect.Message

func (*ExtendLockRequest) Reset added in v0.6.0 

func (x *ExtendLockRequest) Reset()

func (*ExtendLockRequest) String added in v0.6.0 

func (x *ExtendLockRequest) String() string

type GetAllActiveSchemasRequest 

type GetAllActiveSchemasRequest struct {
	WaitSeconds int64             `protobuf:"varint,1,opt,name=wait_seconds,json=waitSeconds,proto3" json:"wait_seconds,omitempty"`
	Known       map[string]string `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetAllActiveSchemasRequest) Descriptor deprecated 

func (*GetAllActiveSchemasRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAllActiveSchemasRequest.ProtoReflect.Descriptor instead.

func (*GetAllActiveSchemasRequest) GetKnown 

func (x *GetAllActiveSchemasRequest) GetKnown() map[string]string

func (*GetAllActiveSchemasRequest) GetWaitSeconds 

func (x *GetAllActiveSchemasRequest) GetWaitSeconds() int64

func (*GetAllActiveSchemasRequest) ProtoMessage 

func (*GetAllActiveSchemasRequest) ProtoMessage()

func (*GetAllActiveSchemasRequest) ProtoReflect 

func (x *GetAllActiveSchemasRequest) ProtoReflect() protoreflect.Message

func (*GetAllActiveSchemasRequest) Reset 

func (x *GetAllActiveSchemasRequest) Reset()

func (*GetAllActiveSchemasRequest) String 

func (x *GetAllActiveSchemasRequest) String() string

type GetAllActiveSchemasResponse 

type GetAllActiveSchemasResponse struct {
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAllActiveSchemasResponse) Descriptor deprecated 

func (*GetAllActiveSchemasResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetAllActiveSchemasResponse.ProtoReflect.Descriptor instead.

func (*GetAllActiveSchemasResponse) GetSchemas 

func (x *GetAllActiveSchemasResponse) GetSchemas() []*Schema

func (*GetAllActiveSchemasResponse) ProtoMessage 

func (*GetAllActiveSchemasResponse) ProtoMessage()

func (*GetAllActiveSchemasResponse) ProtoReflect 

func (x *GetAllActiveSchemasResponse) ProtoReflect() protoreflect.Message

func (*GetAllActiveSchemasResponse) Reset 

func (x *GetAllActiveSchemasResponse) Reset()

func (*GetAllActiveSchemasResponse) String 

func (x *GetAllActiveSchemasResponse) String() string

type GetCompactedEventlogRequest added in v0.7.0 

type GetCompactedEventlogRequest struct {

	// After specifies the event ID after which to start returning events.
	After int64 `protobuf:"varint,1,opt,name=after,proto3" json:"after,omitempty"`
	// Until allows us to control the number of events we want to evaluate when
	// compacting. Must be between 1 and 10000 more than `after`, and cannot be
	// greater than the current last event.
	Until int64 `protobuf:"varint,3,opt,name=until,proto3" json:"until,omitempty"`
	// Limit restricts the number of events we want returned for each
	// call. Together with `offset` this allows us to page through the unique
	// document events between `after` and `until`. Defaults to 0, meaning no
	// limit.
	Limit int32 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// Offset allows us to skip N number of events relative to `after`. So while
	// `after` and until allows us to paginate through the log as a whole,
	// `offset` and `limit` allows us to page through the unique document events
	// between `after` and `until`. Defaults to 0, meaning no offset.
	Offset int32 `protobuf:"varint,5,opt,name=offset,proto3" json:"offset,omitempty"`
	// Type is used to only return events for documents of the given
	// type. Defaults to empty, which will return events for all document types.
	Type string `protobuf:"bytes,6,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCompactedEventlogRequest) Descriptor deprecated added in v0.7.0 

func (*GetCompactedEventlogRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCompactedEventlogRequest.ProtoReflect.Descriptor instead.

func (*GetCompactedEventlogRequest) GetAfter added in v0.7.0 

func (x *GetCompactedEventlogRequest) GetAfter() int64

func (*GetCompactedEventlogRequest) GetLimit added in v0.7.0 

func (x *GetCompactedEventlogRequest) GetLimit() int32

func (*GetCompactedEventlogRequest) GetOffset added in v0.7.0 

func (x *GetCompactedEventlogRequest) GetOffset() int32

func (*GetCompactedEventlogRequest) GetType added in v0.7.0 

func (x *GetCompactedEventlogRequest) GetType() string

func (*GetCompactedEventlogRequest) GetUntil added in v0.7.0 

func (x *GetCompactedEventlogRequest) GetUntil() int64

func (*GetCompactedEventlogRequest) ProtoMessage added in v0.7.0 

func (*GetCompactedEventlogRequest) ProtoMessage()

func (*GetCompactedEventlogRequest) ProtoReflect added in v0.7.0 

func (x *GetCompactedEventlogRequest) ProtoReflect() protoreflect.Message

func (*GetCompactedEventlogRequest) Reset added in v0.7.0 

func (x *GetCompactedEventlogRequest) Reset()

func (*GetCompactedEventlogRequest) String added in v0.7.0 

func (x *GetCompactedEventlogRequest) String() string

type GetCompactedEventlogResponse added in v0.7.0 

type GetCompactedEventlogResponse struct {
	Items []*EventlogItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCompactedEventlogResponse) Descriptor deprecated added in v0.7.0 

func (*GetCompactedEventlogResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetCompactedEventlogResponse.ProtoReflect.Descriptor instead.

func (*GetCompactedEventlogResponse) GetItems added in v0.7.0 

func (x *GetCompactedEventlogResponse) GetItems() []*EventlogItem

func (*GetCompactedEventlogResponse) ProtoMessage added in v0.7.0 

func (*GetCompactedEventlogResponse) ProtoMessage()

func (*GetCompactedEventlogResponse) ProtoReflect added in v0.7.0 

func (x *GetCompactedEventlogResponse) ProtoReflect() protoreflect.Message

func (*GetCompactedEventlogResponse) Reset added in v0.7.0 

func (x *GetCompactedEventlogResponse) Reset()

func (*GetCompactedEventlogResponse) String added in v0.7.0 

func (x *GetCompactedEventlogResponse) String() string

type GetDeprecationsRequest added in v0.11.0 

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

func (*GetDeprecationsRequest) Descriptor deprecated added in v0.11.0 

func (*GetDeprecationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDeprecationsRequest.ProtoReflect.Descriptor instead.

func (*GetDeprecationsRequest) ProtoMessage added in v0.11.0 

func (*GetDeprecationsRequest) ProtoMessage()

func (*GetDeprecationsRequest) ProtoReflect added in v0.11.0 

func (x *GetDeprecationsRequest) ProtoReflect() protoreflect.Message

func (*GetDeprecationsRequest) Reset added in v0.11.0 

func (x *GetDeprecationsRequest) Reset()

func (*GetDeprecationsRequest) String added in v0.11.0 

func (x *GetDeprecationsRequest) String() string

type GetDeprecationsResponse added in v0.11.0 

type GetDeprecationsResponse struct {
	Deprecations []*Deprecation `protobuf:"bytes,1,rep,name=deprecations,proto3" json:"deprecations,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDeprecationsResponse) Descriptor deprecated added in v0.11.0 

func (*GetDeprecationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDeprecationsResponse.ProtoReflect.Descriptor instead.

func (*GetDeprecationsResponse) GetDeprecations added in v0.11.0 

func (x *GetDeprecationsResponse) GetDeprecations() []*Deprecation

func (*GetDeprecationsResponse) ProtoMessage added in v0.11.0 

func (*GetDeprecationsResponse) ProtoMessage()

func (*GetDeprecationsResponse) ProtoReflect added in v0.11.0 

func (x *GetDeprecationsResponse) ProtoReflect() protoreflect.Message

func (*GetDeprecationsResponse) Reset added in v0.11.0 

func (x *GetDeprecationsResponse) Reset()

func (*GetDeprecationsResponse) String added in v0.11.0 

func (x *GetDeprecationsResponse) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {

	// UUID of the document to get.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Version to get, omit to get latest (or use status).
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Status is used to fetch the version of the document references by the last
	// status update. Can be used instead of specifying a version.
	Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// Lock will lock the document for updates. This only affects the creation of
	// new versions of the document, statuses can still be updated.
	Lock bool `protobuf:"varint,4,opt,name=lock,proto3" json:"lock,omitempty"`
	// MetaDocument controls the inclusion of associated meta
	// documents. "META_INCLUDE" will include the document if it
	// exists. "META_ONLY" will only return the meta document, and will return a
	// not found error if it doesn't exist.
	MetaDocument GetMetaDoc `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetDocumentRequest) Descriptor deprecated 

func (*GetDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetLock 

func (x *GetDocumentRequest) GetLock() bool

func (*GetDocumentRequest) GetMetaDocument added in v0.10.0 

func (x *GetDocumentRequest) GetMetaDocument() GetMetaDoc

func (*GetDocumentRequest) GetStatus 

func (x *GetDocumentRequest) GetStatus() string

func (*GetDocumentRequest) GetUuid 

func (x *GetDocumentRequest) GetUuid() string

func (*GetDocumentRequest) GetVersion 

func (x *GetDocumentRequest) GetVersion() int64

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect 

func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentRequest) Reset 

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (x *GetDocumentRequest) String() string

type GetDocumentResponse 

type GetDocumentResponse struct {

	// Document is the requested document.
	Document *newsdoc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Version is the version of the returned document.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Status is returned if the document was requested by status name.
	Status *Status `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
	// Meta contains the meta document, if requested, and if it exists.
	Meta *MetaDocument `protobuf:"bytes,4,opt,name=meta,proto3" json:"meta,omitempty"`
	// IsMetaDocument is true if the document is a meta document.
	IsMetaDocument bool `protobuf:"varint,5,opt,name=is_meta_document,json=isMetaDocument,proto3" json:"is_meta_document,omitempty"`
	// MainDocument is the UUID of the main document if this is a meta document.
	MainDocument string `protobuf:"bytes,6,opt,name=main_document,json=mainDocument,proto3" json:"main_document,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentResponse) Descriptor deprecated 

func (*GetDocumentResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentResponse.ProtoReflect.Descriptor instead.

func (*GetDocumentResponse) GetDocument 

func (x *GetDocumentResponse) GetDocument() *newsdoc.Document

func (*GetDocumentResponse) GetIsMetaDocument added in v0.10.0 

func (x *GetDocumentResponse) GetIsMetaDocument() bool

func (*GetDocumentResponse) GetMainDocument added in v0.10.0 

func (x *GetDocumentResponse) GetMainDocument() string

func (*GetDocumentResponse) GetMeta added in v0.10.0 

func (x *GetDocumentResponse) GetMeta() *MetaDocument

func (*GetDocumentResponse) GetStatus added in v0.8.0 

func (x *GetDocumentResponse) GetStatus() *Status

func (*GetDocumentResponse) GetVersion 

func (x *GetDocumentResponse) GetVersion() int64

func (*GetDocumentResponse) ProtoMessage 

func (*GetDocumentResponse) ProtoMessage()

func (*GetDocumentResponse) ProtoReflect 

func (x *GetDocumentResponse) ProtoReflect() protoreflect.Message

func (*GetDocumentResponse) Reset 

func (x *GetDocumentResponse) Reset()

func (*GetDocumentResponse) String 

func (x *GetDocumentResponse) String() string

type GetEventlogRequest 

type GetEventlogRequest struct {

	// After specifies the event ID after which to start returning events. A
	// negative value of -N will start from the N most recent events.
	After int64 `protobuf:"varint,1,opt,name=after,proto3" json:"after,omitempty"`
	// Wait is the maximum time to wait for new events. Defaults to 2000.
	WaitMs int32 `protobuf:"varint,2,opt,name=wait_ms,json=waitMs,proto3" json:"wait_ms,omitempty"`
	// BatchSize is the number of events we want in the response. Defaults to 10.
	BatchSize int32 `protobuf:"varint,3,opt,name=batch_size,json=batchSize,proto3" json:"batch_size,omitempty"`
	// BatchWaitMs is the maximum time we wait for a batch to be filled. Defaults to 200.
	BatchWaitMs int32 `protobuf:"varint,4,opt,name=batch_wait_ms,json=batchWaitMs,proto3" json:"batch_wait_ms,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventlogRequest) Descriptor deprecated 

func (*GetEventlogRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEventlogRequest.ProtoReflect.Descriptor instead.

func (*GetEventlogRequest) GetAfter 

func (x *GetEventlogRequest) GetAfter() int64

func (*GetEventlogRequest) GetBatchSize 

func (x *GetEventlogRequest) GetBatchSize() int32

func (*GetEventlogRequest) GetBatchWaitMs 

func (x *GetEventlogRequest) GetBatchWaitMs() int32

func (*GetEventlogRequest) GetWaitMs 

func (x *GetEventlogRequest) GetWaitMs() int32

func (*GetEventlogRequest) ProtoMessage 

func (*GetEventlogRequest) ProtoMessage()

func (*GetEventlogRequest) ProtoReflect 

func (x *GetEventlogRequest) ProtoReflect() protoreflect.Message

func (*GetEventlogRequest) Reset 

func (x *GetEventlogRequest) Reset()

func (*GetEventlogRequest) String 

func (x *GetEventlogRequest) String() string

type GetEventlogResponse 

type GetEventlogResponse struct {
	Items []*EventlogItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*GetEventlogResponse) Descriptor deprecated 

func (*GetEventlogResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetEventlogResponse.ProtoReflect.Descriptor instead.

func (*GetEventlogResponse) GetItems 

func (x *GetEventlogResponse) GetItems() []*EventlogItem

func (*GetEventlogResponse) ProtoMessage 

func (*GetEventlogResponse) ProtoMessage()

func (*GetEventlogResponse) ProtoReflect 

func (x *GetEventlogResponse) ProtoReflect() protoreflect.Message

func (*GetEventlogResponse) Reset 

func (x *GetEventlogResponse) Reset()

func (*GetEventlogResponse) String 

func (x *GetEventlogResponse) String() string

type GetHistoryRequest 

type GetHistoryRequest struct {

	// UUID of the document to get the history for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Before is which version number we should start fetching history from, omit
	// to start with the latest version.
	Before int64 `protobuf:"varint,2,opt,name=before,proto3" json:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*GetHistoryRequest) Descriptor deprecated 

func (*GetHistoryRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetHistoryRequest.ProtoReflect.Descriptor instead.

func (*GetHistoryRequest) GetBefore 

func (x *GetHistoryRequest) GetBefore() int64

func (*GetHistoryRequest) GetUuid 

func (x *GetHistoryRequest) GetUuid() string

func (*GetHistoryRequest) ProtoMessage 

func (*GetHistoryRequest) ProtoMessage()

func (*GetHistoryRequest) ProtoReflect 

func (x *GetHistoryRequest) ProtoReflect() protoreflect.Message

func (*GetHistoryRequest) Reset 

func (x *GetHistoryRequest) Reset()

func (*GetHistoryRequest) String 

func (x *GetHistoryRequest) String() string

type GetHistoryResponse 

type GetHistoryResponse struct {
	Versions []*DocumentVersion `protobuf:"bytes,1,rep,name=versions,proto3" json:"versions,omitempty"`
	// contains filtered or unexported fields
}

func (*GetHistoryResponse) Descriptor deprecated 

func (*GetHistoryResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetHistoryResponse.ProtoReflect.Descriptor instead.

func (*GetHistoryResponse) GetVersions 

func (x *GetHistoryResponse) GetVersions() []*DocumentVersion

func (*GetHistoryResponse) ProtoMessage 

func (*GetHistoryResponse) ProtoMessage()

func (*GetHistoryResponse) ProtoReflect 

func (x *GetHistoryResponse) ProtoReflect() protoreflect.Message

func (*GetHistoryResponse) Reset 

func (x *GetHistoryResponse) Reset()

func (*GetHistoryResponse) String 

func (x *GetHistoryResponse) String() string

type GetMetaDoc added in v0.10.0 

type GetMetaDoc int32
const (
	GetMetaDoc_META_NONE    GetMetaDoc = 0
	GetMetaDoc_META_INCLUDE GetMetaDoc = 1
	GetMetaDoc_META_ONLY    GetMetaDoc = 2
)

func (GetMetaDoc) Descriptor added in v0.10.0 

func (GetMetaDoc) Descriptor() protoreflect.EnumDescriptor

func (GetMetaDoc) Enum added in v0.10.0 

func (x GetMetaDoc) Enum() *GetMetaDoc

func (GetMetaDoc) EnumDescriptor deprecated added in v0.10.0 

func (GetMetaDoc) EnumDescriptor() ([]byte, []int)

Deprecated: Use GetMetaDoc.Descriptor instead.

func (GetMetaDoc) Number added in v0.10.0 

func (x GetMetaDoc) Number() protoreflect.EnumNumber

func (GetMetaDoc) String added in v0.10.0 

func (x GetMetaDoc) String() string

func (GetMetaDoc) Type added in v0.10.0 

func (GetMetaDoc) Type() protoreflect.EnumType

type GetMetaRequest 

type GetMetaRequest struct {

	// UUID of the document to get metadata for
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetaRequest) Descriptor deprecated 

func (*GetMetaRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMetaRequest.ProtoReflect.Descriptor instead.

func (*GetMetaRequest) GetUuid 

func (x *GetMetaRequest) GetUuid() string

func (*GetMetaRequest) ProtoMessage 

func (*GetMetaRequest) ProtoMessage()

func (*GetMetaRequest) ProtoReflect 

func (x *GetMetaRequest) ProtoReflect() protoreflect.Message

func (*GetMetaRequest) Reset 

func (x *GetMetaRequest) Reset()

func (*GetMetaRequest) String 

func (x *GetMetaRequest) String() string

type GetMetaResponse 

type GetMetaResponse struct {
	Meta *DocumentMeta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetaResponse) Descriptor deprecated 

func (*GetMetaResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetMetaResponse.ProtoReflect.Descriptor instead.

func (*GetMetaResponse) GetMeta 

func (x *GetMetaResponse) GetMeta() *DocumentMeta

func (*GetMetaResponse) ProtoMessage 

func (*GetMetaResponse) ProtoMessage()

func (*GetMetaResponse) ProtoReflect 

func (x *GetMetaResponse) ProtoReflect() protoreflect.Message

func (*GetMetaResponse) Reset 

func (x *GetMetaResponse) Reset()

func (*GetMetaResponse) String 

func (x *GetMetaResponse) String() string

type GetMetricKindsRequest 

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

func (*GetMetricKindsRequest) Descriptor deprecated 

func (*GetMetricKindsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetMetricKindsRequest.ProtoReflect.Descriptor instead.

func (*GetMetricKindsRequest) ProtoMessage 

func (*GetMetricKindsRequest) ProtoMessage()

func (*GetMetricKindsRequest) ProtoReflect 

func (x *GetMetricKindsRequest) ProtoReflect() protoreflect.Message

func (*GetMetricKindsRequest) Reset 

func (x *GetMetricKindsRequest) Reset()

func (*GetMetricKindsRequest) String 

func (x *GetMetricKindsRequest) String() string

type GetMetricKindsResponse 

type GetMetricKindsResponse struct {
	Kinds []*MetricKind `protobuf:"bytes,1,rep,name=kinds,proto3" json:"kinds,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetricKindsResponse) Descriptor deprecated 

func (*GetMetricKindsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetMetricKindsResponse.ProtoReflect.Descriptor instead.

func (*GetMetricKindsResponse) GetKinds 

func (x *GetMetricKindsResponse) GetKinds() []*MetricKind

func (*GetMetricKindsResponse) ProtoMessage 

func (*GetMetricKindsResponse) ProtoMessage()

func (*GetMetricKindsResponse) ProtoReflect 

func (x *GetMetricKindsResponse) ProtoReflect() protoreflect.Message

func (*GetMetricKindsResponse) Reset 

func (x *GetMetricKindsResponse) Reset()

func (*GetMetricKindsResponse) String 

func (x *GetMetricKindsResponse) String() string

type GetPermissionsRequest added in v0.4.0 

type GetPermissionsRequest struct {

	// UUID of the document to get the permissions for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetPermissionsRequest) Descriptor deprecated added in v0.4.0 

func (*GetPermissionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPermissionsRequest.ProtoReflect.Descriptor instead.

func (*GetPermissionsRequest) GetUuid added in v0.4.0 

func (x *GetPermissionsRequest) GetUuid() string

func (*GetPermissionsRequest) ProtoMessage added in v0.4.0 

func (*GetPermissionsRequest) ProtoMessage()

func (*GetPermissionsRequest) ProtoReflect added in v0.4.0 

func (x *GetPermissionsRequest) ProtoReflect() protoreflect.Message

func (*GetPermissionsRequest) Reset added in v0.4.0 

func (x *GetPermissionsRequest) Reset()

func (*GetPermissionsRequest) String added in v0.4.0 

func (x *GetPermissionsRequest) String() string

type GetPermissionsResponse added in v0.4.0 

type GetPermissionsResponse struct {

	// Permissions that the client has for the document. The map is keyed by the
	// permission the client has and the value is either the client subject, the
	// unit URI if the permission was granted through a unit membership, or
	// "scope://[name]" if it was granted through elevated privileges.
	Permissions map[string]string `` /* 163-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetPermissionsResponse) Descriptor deprecated added in v0.4.0 

func (*GetPermissionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetPermissionsResponse.ProtoReflect.Descriptor instead.

func (*GetPermissionsResponse) GetPermissions added in v0.4.0 

func (x *GetPermissionsResponse) GetPermissions() map[string]string

func (*GetPermissionsResponse) ProtoMessage added in v0.4.0 

func (*GetPermissionsResponse) ProtoMessage()

func (*GetPermissionsResponse) ProtoReflect added in v0.4.0 

func (x *GetPermissionsResponse) ProtoReflect() protoreflect.Message

func (*GetPermissionsResponse) Reset added in v0.4.0 

func (x *GetPermissionsResponse) Reset()

func (*GetPermissionsResponse) String added in v0.4.0 

func (x *GetPermissionsResponse) String() string

type GetReportRequest 

type GetReportRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*GetReportRequest) Descriptor deprecated 

func (*GetReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetReportRequest.ProtoReflect.Descriptor instead.

func (*GetReportRequest) GetName 

func (x *GetReportRequest) GetName() string

func (*GetReportRequest) ProtoMessage 

func (*GetReportRequest) ProtoMessage()

func (*GetReportRequest) ProtoReflect 

func (x *GetReportRequest) ProtoReflect() protoreflect.Message

func (*GetReportRequest) Reset 

func (x *GetReportRequest) Reset()

func (*GetReportRequest) String 

func (x *GetReportRequest) String() string

type GetReportResponse 

type GetReportResponse struct {
	Report        *Report `protobuf:"bytes,1,opt,name=report,proto3" json:"report,omitempty"`
	Enabled       bool    `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	NextExecution string  `protobuf:"bytes,3,opt,name=next_execution,json=nextExecution,proto3" json:"next_execution,omitempty"`
	// contains filtered or unexported fields
}

func (*GetReportResponse) Descriptor deprecated 

func (*GetReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetReportResponse.ProtoReflect.Descriptor instead.

func (*GetReportResponse) GetEnabled 

func (x *GetReportResponse) GetEnabled() bool

func (*GetReportResponse) GetNextExecution 

func (x *GetReportResponse) GetNextExecution() string

func (*GetReportResponse) GetReport 

func (x *GetReportResponse) GetReport() *Report

func (*GetReportResponse) ProtoMessage 

func (*GetReportResponse) ProtoMessage()

func (*GetReportResponse) ProtoReflect 

func (x *GetReportResponse) ProtoReflect() protoreflect.Message

func (*GetReportResponse) Reset 

func (x *GetReportResponse) Reset()

func (*GetReportResponse) String 

func (x *GetReportResponse) String() string

type GetSchemaRequest 

type GetSchemaRequest struct {

	// Name of the schema to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the schema to get, optional. The currently active version of the
	// schema will be returned if no version is specified.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSchemaRequest) Descriptor deprecated 

func (*GetSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetSchemaRequest.ProtoReflect.Descriptor instead.

func (*GetSchemaRequest) GetName 

func (x *GetSchemaRequest) GetName() string

func (*GetSchemaRequest) GetVersion 

func (x *GetSchemaRequest) GetVersion() string

func (*GetSchemaRequest) ProtoMessage 

func (*GetSchemaRequest) ProtoMessage()

func (*GetSchemaRequest) ProtoReflect 

func (x *GetSchemaRequest) ProtoReflect() protoreflect.Message

func (*GetSchemaRequest) Reset 

func (x *GetSchemaRequest) Reset()

func (*GetSchemaRequest) String 

func (x *GetSchemaRequest) String() string

type GetSchemaResponse 

type GetSchemaResponse struct {
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	Spec    []byte `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSchemaResponse) Descriptor deprecated 

func (*GetSchemaResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetSchemaResponse.ProtoReflect.Descriptor instead.

func (*GetSchemaResponse) GetSpec 

func (x *GetSchemaResponse) GetSpec() []byte

func (*GetSchemaResponse) GetVersion 

func (x *GetSchemaResponse) GetVersion() string

func (*GetSchemaResponse) ProtoMessage 

func (*GetSchemaResponse) ProtoMessage()

func (*GetSchemaResponse) ProtoReflect 

func (x *GetSchemaResponse) ProtoReflect() protoreflect.Message

func (*GetSchemaResponse) Reset 

func (x *GetSchemaResponse) Reset()

func (*GetSchemaResponse) String 

func (x *GetSchemaResponse) String() string

type GetStatusHistoryReponse 

type GetStatusHistoryReponse struct {
	Statuses []*Status `protobuf:"bytes,1,rep,name=statuses,proto3" json:"statuses,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusHistoryReponse) Descriptor deprecated 

func (*GetStatusHistoryReponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusHistoryReponse.ProtoReflect.Descriptor instead.

func (*GetStatusHistoryReponse) GetStatuses 

func (x *GetStatusHistoryReponse) GetStatuses() []*Status

func (*GetStatusHistoryReponse) ProtoMessage 

func (*GetStatusHistoryReponse) ProtoMessage()

func (*GetStatusHistoryReponse) ProtoReflect 

func (x *GetStatusHistoryReponse) ProtoReflect() protoreflect.Message

func (*GetStatusHistoryReponse) Reset 

func (x *GetStatusHistoryReponse) Reset()

func (*GetStatusHistoryReponse) String 

func (x *GetStatusHistoryReponse) String() string

type GetStatusHistoryRequest 

type GetStatusHistoryRequest struct {

	// UUID of the document to get the status history for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Name of the status to get.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Before is a status ID used to page backwards through the status history. If
	// no ID or a zero ID is provided the list will start with the lastest status.
	Before int64 `protobuf:"varint,3,opt,name=before,proto3" json:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusHistoryRequest) Descriptor deprecated 

func (*GetStatusHistoryRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusHistoryRequest.ProtoReflect.Descriptor instead.

func (*GetStatusHistoryRequest) GetBefore 

func (x *GetStatusHistoryRequest) GetBefore() int64

func (*GetStatusHistoryRequest) GetName 

func (x *GetStatusHistoryRequest) GetName() string

func (*GetStatusHistoryRequest) GetUuid 

func (x *GetStatusHistoryRequest) GetUuid() string

func (*GetStatusHistoryRequest) ProtoMessage 

func (*GetStatusHistoryRequest) ProtoMessage()

func (*GetStatusHistoryRequest) ProtoReflect 

func (x *GetStatusHistoryRequest) ProtoReflect() protoreflect.Message

func (*GetStatusHistoryRequest) Reset 

func (x *GetStatusHistoryRequest) Reset()

func (*GetStatusHistoryRequest) String 

func (x *GetStatusHistoryRequest) String() string

type GetStatusOverviewRequest added in v0.12.0 

type GetStatusOverviewRequest struct {

	// UUIDs to get statuses for.
	Uuids []string `protobuf:"bytes,1,rep,name=uuids,proto3" json:"uuids,omitempty"`
	// Statuses to return information for.
	Statuses []string `protobuf:"bytes,2,rep,name=statuses,proto3" json:"statuses,omitempty"`
	// GetMeta can be used to load any set status metadata.
	GetMeta bool `protobuf:"varint,3,opt,name=get_meta,json=getMeta,proto3" json:"get_meta,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusOverviewRequest) Descriptor deprecated added in v0.12.0 

func (*GetStatusOverviewRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusOverviewRequest.ProtoReflect.Descriptor instead.

func (*GetStatusOverviewRequest) GetGetMeta added in v0.12.0 

func (x *GetStatusOverviewRequest) GetGetMeta() bool

func (*GetStatusOverviewRequest) GetStatuses added in v0.12.0 

func (x *GetStatusOverviewRequest) GetStatuses() []string

func (*GetStatusOverviewRequest) GetUuids added in v0.12.0 

func (x *GetStatusOverviewRequest) GetUuids() []string

func (*GetStatusOverviewRequest) ProtoMessage added in v0.12.0 

func (*GetStatusOverviewRequest) ProtoMessage()

func (*GetStatusOverviewRequest) ProtoReflect added in v0.12.0 

func (x *GetStatusOverviewRequest) ProtoReflect() protoreflect.Message

func (*GetStatusOverviewRequest) Reset added in v0.12.0 

func (x *GetStatusOverviewRequest) Reset()

func (*GetStatusOverviewRequest) String added in v0.12.0 

func (x *GetStatusOverviewRequest) String() string

type GetStatusOverviewResponse added in v0.12.0 

type GetStatusOverviewResponse struct {
	Items []*StatusOverviewItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusOverviewResponse) Descriptor deprecated added in v0.12.0 

func (*GetStatusOverviewResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusOverviewResponse.ProtoReflect.Descriptor instead.

func (*GetStatusOverviewResponse) GetItems added in v0.12.0 

func (x *GetStatusOverviewResponse) GetItems() []*StatusOverviewItem

func (*GetStatusOverviewResponse) ProtoMessage added in v0.12.0 

func (*GetStatusOverviewResponse) ProtoMessage()

func (*GetStatusOverviewResponse) ProtoReflect added in v0.12.0 

func (x *GetStatusOverviewResponse) ProtoReflect() protoreflect.Message

func (*GetStatusOverviewResponse) Reset added in v0.12.0 

func (x *GetStatusOverviewResponse) Reset()

func (*GetStatusOverviewResponse) String added in v0.12.0 

func (x *GetStatusOverviewResponse) String() string

type GetStatusRequest added in v0.17.4 

type GetStatusRequest struct {

	// UUID of the document to get the status history for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Name of the status to get.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// ID of the status to get. Optional, will default to the latest status.
	Id int64 `protobuf:"varint,3,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusRequest) Descriptor deprecated added in v0.17.4 

func (*GetStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusRequest.ProtoReflect.Descriptor instead.

func (*GetStatusRequest) GetId added in v0.17.4 

func (x *GetStatusRequest) GetId() int64

func (*GetStatusRequest) GetName added in v0.17.4 

func (x *GetStatusRequest) GetName() string

func (*GetStatusRequest) GetUuid added in v0.17.4 

func (x *GetStatusRequest) GetUuid() string

func (*GetStatusRequest) ProtoMessage added in v0.17.4 

func (*GetStatusRequest) ProtoMessage()

func (*GetStatusRequest) ProtoReflect added in v0.17.4 

func (x *GetStatusRequest) ProtoReflect() protoreflect.Message

func (*GetStatusRequest) Reset added in v0.17.4 

func (x *GetStatusRequest) Reset()

func (*GetStatusRequest) String added in v0.17.4 

func (x *GetStatusRequest) String() string

type GetStatusResponse added in v0.17.4 

type GetStatusResponse struct {
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusResponse) Descriptor deprecated added in v0.17.4 

func (*GetStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusResponse.ProtoReflect.Descriptor instead.

func (*GetStatusResponse) GetStatus added in v0.17.4 

func (x *GetStatusResponse) GetStatus() *Status

func (*GetStatusResponse) ProtoMessage added in v0.17.4 

func (*GetStatusResponse) ProtoMessage()

func (*GetStatusResponse) ProtoReflect added in v0.17.4 

func (x *GetStatusResponse) ProtoReflect() protoreflect.Message

func (*GetStatusResponse) Reset added in v0.17.4 

func (x *GetStatusResponse) Reset()

func (*GetStatusResponse) String added in v0.17.4 

func (x *GetStatusResponse) String() string

type GetStatusRulesRequest 

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

func (*GetStatusRulesRequest) Descriptor deprecated 

func (*GetStatusRulesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusRulesRequest.ProtoReflect.Descriptor instead.

func (*GetStatusRulesRequest) ProtoMessage 

func (*GetStatusRulesRequest) ProtoMessage()

func (*GetStatusRulesRequest) ProtoReflect 

func (x *GetStatusRulesRequest) ProtoReflect() protoreflect.Message

func (*GetStatusRulesRequest) Reset 

func (x *GetStatusRulesRequest) Reset()

func (*GetStatusRulesRequest) String 

func (x *GetStatusRulesRequest) String() string

type GetStatusRulesResponse 

type GetStatusRulesResponse struct {
	Rules []*StatusRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusRulesResponse) Descriptor deprecated 

func (*GetStatusRulesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusRulesResponse.ProtoReflect.Descriptor instead.

func (*GetStatusRulesResponse) GetRules 

func (x *GetStatusRulesResponse) GetRules() []*StatusRule

func (*GetStatusRulesResponse) ProtoMessage 

func (*GetStatusRulesResponse) ProtoMessage()

func (*GetStatusRulesResponse) ProtoReflect 

func (x *GetStatusRulesResponse) ProtoReflect() protoreflect.Message

func (*GetStatusRulesResponse) Reset 

func (x *GetStatusRulesResponse) Reset()

func (*GetStatusRulesResponse) String 

func (x *GetStatusRulesResponse) String() string

type GetStatusesRequest 

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

func (*GetStatusesRequest) Descriptor deprecated 

func (*GetStatusesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusesRequest.ProtoReflect.Descriptor instead.

func (*GetStatusesRequest) ProtoMessage 

func (*GetStatusesRequest) ProtoMessage()

func (*GetStatusesRequest) ProtoReflect 

func (x *GetStatusesRequest) ProtoReflect() protoreflect.Message

func (*GetStatusesRequest) Reset 

func (x *GetStatusesRequest) Reset()

func (*GetStatusesRequest) String 

func (x *GetStatusesRequest) String() string

type GetStatusesResponse 

type GetStatusesResponse struct {
	Statuses []*WorkflowStatus `protobuf:"bytes,1,rep,name=statuses,proto3" json:"statuses,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusesResponse) Descriptor deprecated 

func (*GetStatusesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStatusesResponse.ProtoReflect.Descriptor instead.

func (*GetStatusesResponse) GetStatuses 

func (x *GetStatusesResponse) GetStatuses() []*WorkflowStatus

func (*GetStatusesResponse) ProtoMessage 

func (*GetStatusesResponse) ProtoMessage()

func (*GetStatusesResponse) ProtoReflect 

func (x *GetStatusesResponse) ProtoReflect() protoreflect.Message

func (*GetStatusesResponse) Reset 

func (x *GetStatusesResponse) Reset()

func (*GetStatusesResponse) String 

func (x *GetStatusesResponse) String() string

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.

HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.

type ImportDirective 

type ImportDirective struct {
	OriginallyCreated string `protobuf:"bytes,1,opt,name=originally_created,json=originallyCreated,proto3" json:"originally_created,omitempty"`
	OriginalCreator   string `protobuf:"bytes,2,opt,name=original_creator,json=originalCreator,proto3" json:"original_creator,omitempty"`
	// contains filtered or unexported fields
}

ImportDirective can be used to preserve timestamps and authorship information from originating systems.

func (*ImportDirective) Descriptor deprecated 

func (*ImportDirective) Descriptor() ([]byte, []int)

Deprecated: Use ImportDirective.ProtoReflect.Descriptor instead.

func (*ImportDirective) GetOriginalCreator 

func (x *ImportDirective) GetOriginalCreator() string

func (*ImportDirective) GetOriginallyCreated 

func (x *ImportDirective) GetOriginallyCreated() string

func (*ImportDirective) ProtoMessage 

func (*ImportDirective) ProtoMessage()

func (*ImportDirective) ProtoReflect 

func (x *ImportDirective) ProtoReflect() protoreflect.Message

func (*ImportDirective) Reset 

func (x *ImportDirective) Reset()

func (*ImportDirective) String 

func (x *ImportDirective) String() string

type ListDeletedRequest added in v0.13.0 

type ListDeletedRequest struct {

	// UUID of the document list deletions of. Optional.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// BeforeID is used to paginate backwards in deletions. Optional.
	BeforeId int64 `protobuf:"varint,2,opt,name=before_id,json=beforeId,proto3" json:"before_id,omitempty"`
	// BeforeDate is used to get deletions going back from before the specified
	// date YYYY-MM-DD. Optional, will be ignored if before_id is specified.
	BeforeDate string `protobuf:"bytes,3,opt,name=before_date,json=beforeDate,proto3" json:"before_date,omitempty"`
	// Timezone that the date should be interpreted in.
	Timezone string `protobuf:"bytes,4,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDeletedRequest) Descriptor deprecated added in v0.13.0 

func (*ListDeletedRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDeletedRequest.ProtoReflect.Descriptor instead.

func (*ListDeletedRequest) GetBeforeDate added in v0.13.0 

func (x *ListDeletedRequest) GetBeforeDate() string

func (*ListDeletedRequest) GetBeforeId added in v0.13.0 

func (x *ListDeletedRequest) GetBeforeId() int64

func (*ListDeletedRequest) GetTimezone added in v0.13.0 

func (x *ListDeletedRequest) GetTimezone() string

func (*ListDeletedRequest) GetUuid added in v0.13.0 

func (x *ListDeletedRequest) GetUuid() string

func (*ListDeletedRequest) ProtoMessage added in v0.13.0 

func (*ListDeletedRequest) ProtoMessage()

func (*ListDeletedRequest) ProtoReflect added in v0.13.0 

func (x *ListDeletedRequest) ProtoReflect() protoreflect.Message

func (*ListDeletedRequest) Reset added in v0.13.0 

func (x *ListDeletedRequest) Reset()

func (*ListDeletedRequest) String added in v0.13.0 

func (x *ListDeletedRequest) String() string

type ListDeletedResponse added in v0.13.0 

type ListDeletedResponse struct {

	// Deletes that have been performed on document instances with the given UUID.
	Deletes []*DeleteRecord `protobuf:"bytes,1,rep,name=deletes,proto3" json:"deletes,omitempty"`
	// contains filtered or unexported fields
}

func (*ListDeletedResponse) Descriptor deprecated added in v0.13.0 

func (*ListDeletedResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDeletedResponse.ProtoReflect.Descriptor instead.

func (*ListDeletedResponse) GetDeletes added in v0.13.0 

func (x *ListDeletedResponse) GetDeletes() []*DeleteRecord

func (*ListDeletedResponse) ProtoMessage added in v0.13.0 

func (*ListDeletedResponse) ProtoMessage()

func (*ListDeletedResponse) ProtoReflect added in v0.13.0 

func (x *ListDeletedResponse) ProtoReflect() protoreflect.Message

func (*ListDeletedResponse) Reset added in v0.13.0 

func (x *ListDeletedResponse) Reset()

func (*ListDeletedResponse) String added in v0.13.0 

func (x *ListDeletedResponse) String() string

type ListReportsRequest added in v0.9.0 

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

func (*ListReportsRequest) Descriptor deprecated added in v0.9.0 

func (*ListReportsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListReportsRequest.ProtoReflect.Descriptor instead.

func (*ListReportsRequest) ProtoMessage added in v0.9.0 

func (*ListReportsRequest) ProtoMessage()

func (*ListReportsRequest) ProtoReflect added in v0.9.0 

func (x *ListReportsRequest) ProtoReflect() protoreflect.Message

func (*ListReportsRequest) Reset added in v0.9.0 

func (x *ListReportsRequest) Reset()

func (*ListReportsRequest) String added in v0.9.0 

func (x *ListReportsRequest) String() string

type ListReportsResponse added in v0.9.0 

type ListReportsResponse struct {
	Reports []*ReportListItem `protobuf:"bytes,1,rep,name=reports,proto3" json:"reports,omitempty"`
	// contains filtered or unexported fields
}

func (*ListReportsResponse) Descriptor deprecated added in v0.9.0 

func (*ListReportsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListReportsResponse.ProtoReflect.Descriptor instead.

func (*ListReportsResponse) GetReports added in v0.9.0 

func (x *ListReportsResponse) GetReports() []*ReportListItem

func (*ListReportsResponse) ProtoMessage added in v0.9.0 

func (*ListReportsResponse) ProtoMessage()

func (*ListReportsResponse) ProtoReflect added in v0.9.0 

func (x *ListReportsResponse) ProtoReflect() protoreflect.Message

func (*ListReportsResponse) Reset added in v0.9.0 

func (x *ListReportsResponse) Reset()

func (*ListReportsResponse) String added in v0.9.0 

func (x *ListReportsResponse) String() string

type Lock added in v0.6.0 

type Lock struct {

	// Lock token string
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// URI of the lock owner
	Uri string `protobuf:"bytes,2,opt,name=uri,proto3" json:"uri,omitempty"`
	// Created timestamp is the RFC3339 timestamp for when the lock was created.
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// Expires timestamp is the RFC3339 timestamp for when the lock will expire.
	Expires string `protobuf:"bytes,4,opt,name=expires,proto3" json:"expires,omitempty"`
	// URI identifying the locking application.
	App string `protobuf:"bytes,5,opt,name=app,proto3" json:"app,omitempty"`
	// Optional free-form comment.
	Comment string `protobuf:"bytes,6,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

func (*Lock) Descriptor deprecated added in v0.6.0 

func (*Lock) Descriptor() ([]byte, []int)

Deprecated: Use Lock.ProtoReflect.Descriptor instead.

func (*Lock) GetApp added in v0.6.0 

func (x *Lock) GetApp() string

func (*Lock) GetComment added in v0.6.0 

func (x *Lock) GetComment() string

func (*Lock) GetCreated added in v0.6.0 

func (x *Lock) GetCreated() string

func (*Lock) GetExpires added in v0.6.0 

func (x *Lock) GetExpires() string

func (*Lock) GetToken added in v0.6.0 

func (x *Lock) GetToken() string

func (*Lock) GetUri added in v0.6.0 

func (x *Lock) GetUri() string

func (*Lock) ProtoMessage added in v0.6.0 

func (*Lock) ProtoMessage()

func (*Lock) ProtoReflect added in v0.6.0 

func (x *Lock) ProtoReflect() protoreflect.Message

func (*Lock) Reset added in v0.6.0 

func (x *Lock) Reset()

func (*Lock) String added in v0.6.0 

func (x *Lock) String() string

type LockRequest added in v0.6.0 

type LockRequest struct {

	// UUID of the document to lock
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Lock TTL in milliseconds
	Ttl int32 `protobuf:"varint,2,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Name of the locking application. Optional.
	App string `protobuf:"bytes,3,opt,name=app,proto3" json:"app,omitempty"`
	// Free-form comment string. Optional.
	Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

func (*LockRequest) Descriptor deprecated added in v0.6.0 

func (*LockRequest) Descriptor() ([]byte, []int)

Deprecated: Use LockRequest.ProtoReflect.Descriptor instead.

func (*LockRequest) GetApp added in v0.6.0 

func (x *LockRequest) GetApp() string

func (*LockRequest) GetComment added in v0.6.0 

func (x *LockRequest) GetComment() string

func (*LockRequest) GetTtl added in v0.6.0 

func (x *LockRequest) GetTtl() int32

func (*LockRequest) GetUuid added in v0.6.0 

func (x *LockRequest) GetUuid() string

func (*LockRequest) ProtoMessage added in v0.6.0 

func (*LockRequest) ProtoMessage()

func (*LockRequest) ProtoReflect added in v0.6.0 

func (x *LockRequest) ProtoReflect() protoreflect.Message

func (*LockRequest) Reset added in v0.6.0 

func (x *LockRequest) Reset()

func (*LockRequest) String added in v0.6.0 

func (x *LockRequest) String() string

type LockResponse added in v0.6.0 

type LockResponse struct {

	// Generated lock token in UUID format.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// Expires is the RFC3339 timestamp when the lock will expire.
	Expires string `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
	// contains filtered or unexported fields
}

func (*LockResponse) Descriptor deprecated added in v0.6.0 

func (*LockResponse) Descriptor() ([]byte, []int)

Deprecated: Use LockResponse.ProtoReflect.Descriptor instead.

func (*LockResponse) GetExpires added in v0.6.0 

func (x *LockResponse) GetExpires() string

func (*LockResponse) GetToken added in v0.6.0 

func (x *LockResponse) GetToken() string

func (*LockResponse) ProtoMessage added in v0.6.0 

func (*LockResponse) ProtoMessage()

func (*LockResponse) ProtoReflect added in v0.6.0 

func (x *LockResponse) ProtoReflect() protoreflect.Message

func (*LockResponse) Reset added in v0.6.0 

func (x *LockResponse) Reset()

func (*LockResponse) String added in v0.6.0 

func (x *LockResponse) String() string

type MetaDocument added in v0.10.0 

type MetaDocument struct {

	// Document is the requested document.
	Document *newsdoc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Version is the version of the returned document.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*MetaDocument) Descriptor deprecated added in v0.10.0 

func (*MetaDocument) Descriptor() ([]byte, []int)

Deprecated: Use MetaDocument.ProtoReflect.Descriptor instead.

func (*MetaDocument) GetDocument added in v0.10.0 

func (x *MetaDocument) GetDocument() *newsdoc.Document

func (*MetaDocument) GetVersion added in v0.10.0 

func (x *MetaDocument) GetVersion() int64

func (*MetaDocument) ProtoMessage added in v0.10.0 

func (*MetaDocument) ProtoMessage()

func (*MetaDocument) ProtoReflect added in v0.10.0 

func (x *MetaDocument) ProtoReflect() protoreflect.Message

func (*MetaDocument) Reset added in v0.10.0 

func (x *MetaDocument) Reset()

func (*MetaDocument) String added in v0.10.0 

func (x *MetaDocument) String() string

type MetricAggregation 

type MetricAggregation int32
const (
	MetricAggregation_NONE      MetricAggregation = 0
	MetricAggregation_REPLACE   MetricAggregation = 1
	MetricAggregation_INCREMENT MetricAggregation = 2
)

func (MetricAggregation) Descriptor 

func (MetricAggregation) Descriptor() protoreflect.EnumDescriptor

func (MetricAggregation) Enum 

func (x MetricAggregation) Enum() *MetricAggregation

func (MetricAggregation) EnumDescriptor deprecated 

func (MetricAggregation) EnumDescriptor() ([]byte, []int)

Deprecated: Use MetricAggregation.Descriptor instead.

func (MetricAggregation) Number 

func (x MetricAggregation) Number() protoreflect.EnumNumber

func (MetricAggregation) String 

func (x MetricAggregation) String() string

func (MetricAggregation) Type 

func (MetricAggregation) Type() protoreflect.EnumType

type MetricKind 

type MetricKind struct {
	Name        string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Aggregation MetricAggregation `protobuf:"varint,2,opt,name=aggregation,proto3,enum=elephant.repository.MetricAggregation" json:"aggregation,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricKind) Descriptor deprecated 

func (*MetricKind) Descriptor() ([]byte, []int)

Deprecated: Use MetricKind.ProtoReflect.Descriptor instead.

func (*MetricKind) GetAggregation 

func (x *MetricKind) GetAggregation() MetricAggregation

func (*MetricKind) GetName 

func (x *MetricKind) GetName() string

func (*MetricKind) ProtoMessage 

func (*MetricKind) ProtoMessage()

func (*MetricKind) ProtoReflect 

func (x *MetricKind) ProtoReflect() protoreflect.Message

func (*MetricKind) Reset 

func (x *MetricKind) Reset()

func (*MetricKind) String 

func (x *MetricKind) String() string

type Metrics 

type Metrics interface {
	// Register a metric kind
	RegisterKind(context.Context, *RegisterMetricKindRequest) (*RegisterMetricKindResponse, error)

	// Delete a metric kind
	DeleteKind(context.Context, *DeleteMetricKindRequest) (*DeleteMetricKindResponse, error)

	// List all metric kinds
	GetKinds(context.Context, *GetMetricKindsRequest) (*GetMetricKindsResponse, error)

	// Register a data point
	RegisterMetric(context.Context, *RegisterMetricRequest) (*RegisterMetricResponse, error)
}

func NewMetricsJSONClient 

func NewMetricsJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Metrics

NewMetricsJSONClient creates a JSON client that implements the Metrics interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewMetricsProtobufClient 

func NewMetricsProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Metrics

NewMetricsProtobufClient creates a Protobuf client that implements the Metrics interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type PurgeRequest added in v0.13.0 

type PurgeRequest struct {

	// UUID of the document to purge.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// DeleteRecordID for the specific instance of the document that should be
	// purged.
	DeleteRecordId int64 `protobuf:"varint,2,opt,name=delete_record_id,json=deleteRecordId,proto3" json:"delete_record_id,omitempty"`
	// contains filtered or unexported fields
}

func (*PurgeRequest) Descriptor deprecated added in v0.13.0 

func (*PurgeRequest) Descriptor() ([]byte, []int)

Deprecated: Use PurgeRequest.ProtoReflect.Descriptor instead.

func (*PurgeRequest) GetDeleteRecordId added in v0.13.0 

func (x *PurgeRequest) GetDeleteRecordId() int64

func (*PurgeRequest) GetUuid added in v0.13.0 

func (x *PurgeRequest) GetUuid() string

func (*PurgeRequest) ProtoMessage added in v0.13.0 

func (*PurgeRequest) ProtoMessage()

func (*PurgeRequest) ProtoReflect added in v0.13.0 

func (x *PurgeRequest) ProtoReflect() protoreflect.Message

func (*PurgeRequest) Reset added in v0.13.0 

func (x *PurgeRequest) Reset()

func (*PurgeRequest) String added in v0.13.0 

func (x *PurgeRequest) String() string

type PurgeResponse added in v0.13.0 

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

func (*PurgeResponse) Descriptor deprecated added in v0.13.0 

func (*PurgeResponse) Descriptor() ([]byte, []int)

Deprecated: Use PurgeResponse.ProtoReflect.Descriptor instead.

func (*PurgeResponse) ProtoMessage added in v0.13.0 

func (*PurgeResponse) ProtoMessage()

func (*PurgeResponse) ProtoReflect added in v0.13.0 

func (x *PurgeResponse) ProtoReflect() protoreflect.Message

func (*PurgeResponse) Reset added in v0.13.0 

func (x *PurgeResponse) Reset()

func (*PurgeResponse) String added in v0.13.0 

func (x *PurgeResponse) String() string

type RegisterMetaTypeRequest added in v0.10.0 

type RegisterMetaTypeRequest struct {

	// Type to use as a meta type.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Exclusive - set to true to only allow the type to be used as a meta type.
	Exclusive bool `protobuf:"varint,2,opt,name=exclusive,proto3" json:"exclusive,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterMetaTypeRequest) Descriptor deprecated added in v0.10.0 

func (*RegisterMetaTypeRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetaTypeRequest.ProtoReflect.Descriptor instead.

func (*RegisterMetaTypeRequest) GetExclusive added in v0.10.0 

func (x *RegisterMetaTypeRequest) GetExclusive() bool

func (*RegisterMetaTypeRequest) GetType added in v0.10.0 

func (x *RegisterMetaTypeRequest) GetType() string

func (*RegisterMetaTypeRequest) ProtoMessage added in v0.10.0 

func (*RegisterMetaTypeRequest) ProtoMessage()

func (*RegisterMetaTypeRequest) ProtoReflect added in v0.10.0 

func (x *RegisterMetaTypeRequest) ProtoReflect() protoreflect.Message

func (*RegisterMetaTypeRequest) Reset added in v0.10.0 

func (x *RegisterMetaTypeRequest) Reset()

func (*RegisterMetaTypeRequest) String added in v0.10.0 

func (x *RegisterMetaTypeRequest) String() string

type RegisterMetaTypeResponse added in v0.10.0 

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

func (*RegisterMetaTypeResponse) Descriptor deprecated added in v0.10.0 

func (*RegisterMetaTypeResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetaTypeResponse.ProtoReflect.Descriptor instead.

func (*RegisterMetaTypeResponse) ProtoMessage added in v0.10.0 

func (*RegisterMetaTypeResponse) ProtoMessage()

func (*RegisterMetaTypeResponse) ProtoReflect added in v0.10.0 

func (x *RegisterMetaTypeResponse) ProtoReflect() protoreflect.Message

func (*RegisterMetaTypeResponse) Reset added in v0.10.0 

func (x *RegisterMetaTypeResponse) Reset()

func (*RegisterMetaTypeResponse) String added in v0.10.0 

func (x *RegisterMetaTypeResponse) String() string

type RegisterMetaTypeUseRequest added in v0.10.0 

type RegisterMetaTypeUseRequest struct {

	// MainType to use the meta type for.
	MainType string `protobuf:"bytes,1,opt,name=main_type,json=mainType,proto3" json:"main_type,omitempty"`
	// MetaType to use for the main document.
	MetaType string `protobuf:"bytes,2,opt,name=meta_type,json=metaType,proto3" json:"meta_type,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterMetaTypeUseRequest) Descriptor deprecated added in v0.10.0 

func (*RegisterMetaTypeUseRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetaTypeUseRequest.ProtoReflect.Descriptor instead.

func (*RegisterMetaTypeUseRequest) GetMainType added in v0.10.0 

func (x *RegisterMetaTypeUseRequest) GetMainType() string

func (*RegisterMetaTypeUseRequest) GetMetaType added in v0.10.0 

func (x *RegisterMetaTypeUseRequest) GetMetaType() string

func (*RegisterMetaTypeUseRequest) ProtoMessage added in v0.10.0 

func (*RegisterMetaTypeUseRequest) ProtoMessage()

func (*RegisterMetaTypeUseRequest) ProtoReflect added in v0.10.0 

func (x *RegisterMetaTypeUseRequest) ProtoReflect() protoreflect.Message

func (*RegisterMetaTypeUseRequest) Reset added in v0.10.0 

func (x *RegisterMetaTypeUseRequest) Reset()

func (*RegisterMetaTypeUseRequest) String added in v0.10.0 

func (x *RegisterMetaTypeUseRequest) String() string

type RegisterMetaTypeUseResponse added in v0.10.0 

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

func (*RegisterMetaTypeUseResponse) Descriptor deprecated added in v0.10.0 

func (*RegisterMetaTypeUseResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetaTypeUseResponse.ProtoReflect.Descriptor instead.

func (*RegisterMetaTypeUseResponse) ProtoMessage added in v0.10.0 

func (*RegisterMetaTypeUseResponse) ProtoMessage()

func (*RegisterMetaTypeUseResponse) ProtoReflect added in v0.10.0 

func (x *RegisterMetaTypeUseResponse) ProtoReflect() protoreflect.Message

func (*RegisterMetaTypeUseResponse) Reset added in v0.10.0 

func (x *RegisterMetaTypeUseResponse) Reset()

func (*RegisterMetaTypeUseResponse) String added in v0.10.0 

func (x *RegisterMetaTypeUseResponse) String() string

type RegisterMetricKindRequest 

type RegisterMetricKindRequest struct {
	Name        string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Aggregation MetricAggregation `protobuf:"varint,2,opt,name=aggregation,proto3,enum=elephant.repository.MetricAggregation" json:"aggregation,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterMetricKindRequest) Descriptor deprecated 

func (*RegisterMetricKindRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetricKindRequest.ProtoReflect.Descriptor instead.

func (*RegisterMetricKindRequest) GetAggregation 

func (x *RegisterMetricKindRequest) GetAggregation() MetricAggregation

func (*RegisterMetricKindRequest) GetName 

func (x *RegisterMetricKindRequest) GetName() string

func (*RegisterMetricKindRequest) ProtoMessage 

func (*RegisterMetricKindRequest) ProtoMessage()

func (*RegisterMetricKindRequest) ProtoReflect 

func (x *RegisterMetricKindRequest) ProtoReflect() protoreflect.Message

func (*RegisterMetricKindRequest) Reset 

func (x *RegisterMetricKindRequest) Reset()

func (*RegisterMetricKindRequest) String 

func (x *RegisterMetricKindRequest) String() string

type RegisterMetricKindResponse 

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

func (*RegisterMetricKindResponse) Descriptor deprecated 

func (*RegisterMetricKindResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetricKindResponse.ProtoReflect.Descriptor instead.

func (*RegisterMetricKindResponse) ProtoMessage 

func (*RegisterMetricKindResponse) ProtoMessage()

func (*RegisterMetricKindResponse) ProtoReflect 

func (x *RegisterMetricKindResponse) ProtoReflect() protoreflect.Message

func (*RegisterMetricKindResponse) Reset 

func (x *RegisterMetricKindResponse) Reset()

func (*RegisterMetricKindResponse) String 

func (x *RegisterMetricKindResponse) String() string

type RegisterMetricRequest 

type RegisterMetricRequest struct {
	Uuid  string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Kind  string `protobuf:"bytes,2,opt,name=kind,proto3" json:"kind,omitempty"`
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	Value int64  `protobuf:"varint,5,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterMetricRequest) Descriptor deprecated 

func (*RegisterMetricRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetricRequest.ProtoReflect.Descriptor instead.

func (*RegisterMetricRequest) GetKind 

func (x *RegisterMetricRequest) GetKind() string

func (*RegisterMetricRequest) GetLabel 

func (x *RegisterMetricRequest) GetLabel() string

func (*RegisterMetricRequest) GetUuid 

func (x *RegisterMetricRequest) GetUuid() string

func (*RegisterMetricRequest) GetValue 

func (x *RegisterMetricRequest) GetValue() int64

func (*RegisterMetricRequest) ProtoMessage 

func (*RegisterMetricRequest) ProtoMessage()

func (*RegisterMetricRequest) ProtoReflect 

func (x *RegisterMetricRequest) ProtoReflect() protoreflect.Message

func (*RegisterMetricRequest) Reset 

func (x *RegisterMetricRequest) Reset()

func (*RegisterMetricRequest) String 

func (x *RegisterMetricRequest) String() string

type RegisterMetricResponse 

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

func (*RegisterMetricResponse) Descriptor deprecated 

func (*RegisterMetricResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterMetricResponse.ProtoReflect.Descriptor instead.

func (*RegisterMetricResponse) ProtoMessage 

func (*RegisterMetricResponse) ProtoMessage()

func (*RegisterMetricResponse) ProtoReflect 

func (x *RegisterMetricResponse) ProtoReflect() protoreflect.Message

func (*RegisterMetricResponse) Reset 

func (x *RegisterMetricResponse) Reset()

func (*RegisterMetricResponse) String 

func (x *RegisterMetricResponse) String() string

type RegisterSchemaRequest 

type RegisterSchemaRequest struct {

	// Schema to register. The spec can be omitted if a schema URL is passed.
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	// Activate the registered schema immediately.
	Activate bool `protobuf:"varint,2,opt,name=activate,proto3" json:"activate,omitempty"`
	// SchemaURL is an HTTP(S) url to the schema to load, can be passed instead of
	// an inline schema spec.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
	// SchemaSHA256 is a SHA256 checksum to validate the response body from the
	// schema URL against.
	SchemaSha256 string `protobuf:"bytes,4,opt,name=schema_sha256,json=schemaSha256,proto3" json:"schema_sha256,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterSchemaRequest) Descriptor deprecated 

func (*RegisterSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use RegisterSchemaRequest.ProtoReflect.Descriptor instead.

func (*RegisterSchemaRequest) GetActivate 

func (x *RegisterSchemaRequest) GetActivate() bool

func (*RegisterSchemaRequest) GetSchema 

func (x *RegisterSchemaRequest) GetSchema() *Schema

func (*RegisterSchemaRequest) GetSchemaSha256 added in v0.7.0 

func (x *RegisterSchemaRequest) GetSchemaSha256() string

func (*RegisterSchemaRequest) GetSchemaUrl added in v0.7.0 

func (x *RegisterSchemaRequest) GetSchemaUrl() string

func (*RegisterSchemaRequest) ProtoMessage 

func (*RegisterSchemaRequest) ProtoMessage()

func (*RegisterSchemaRequest) ProtoReflect 

func (x *RegisterSchemaRequest) ProtoReflect() protoreflect.Message

func (*RegisterSchemaRequest) Reset 

func (x *RegisterSchemaRequest) Reset()

func (*RegisterSchemaRequest) String 

func (x *RegisterSchemaRequest) String() string

type RegisterSchemaResponse 

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

func (*RegisterSchemaResponse) Descriptor deprecated 

func (*RegisterSchemaResponse) Descriptor() ([]byte, []int)

Deprecated: Use RegisterSchemaResponse.ProtoReflect.Descriptor instead.

func (*RegisterSchemaResponse) ProtoMessage 

func (*RegisterSchemaResponse) ProtoMessage()

func (*RegisterSchemaResponse) ProtoReflect 

func (x *RegisterSchemaResponse) ProtoReflect() protoreflect.Message

func (*RegisterSchemaResponse) Reset 

func (x *RegisterSchemaResponse) Reset()

func (*RegisterSchemaResponse) String 

func (x *RegisterSchemaResponse) String() string

type Report 

type Report struct {
	Name           string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Title          string         `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	GenerateSheet  bool           `protobuf:"varint,3,opt,name=generate_sheet,json=generateSheet,proto3" json:"generate_sheet,omitempty"`
	CronExpression string         `protobuf:"bytes,4,opt,name=cron_expression,json=cronExpression,proto3" json:"cron_expression,omitempty"`
	CronTimezone   string         `protobuf:"bytes,7,opt,name=cron_timezone,json=cronTimezone,proto3" json:"cron_timezone,omitempty"` // (default UTC)
	SlackChannels  []string       `protobuf:"bytes,5,rep,name=slack_channels,json=slackChannels,proto3" json:"slack_channels,omitempty"`
	Queries        []*ReportQuery `protobuf:"bytes,6,rep,name=queries,proto3" json:"queries,omitempty"`
	// contains filtered or unexported fields
}

func (*Report) Descriptor deprecated 

func (*Report) Descriptor() ([]byte, []int)

Deprecated: Use Report.ProtoReflect.Descriptor instead.

func (*Report) GetCronExpression 

func (x *Report) GetCronExpression() string

func (*Report) GetCronTimezone 

func (x *Report) GetCronTimezone() string

func (*Report) GetGenerateSheet 

func (x *Report) GetGenerateSheet() bool

func (*Report) GetName 

func (x *Report) GetName() string

func (*Report) GetQueries 

func (x *Report) GetQueries() []*ReportQuery

func (*Report) GetSlackChannels 

func (x *Report) GetSlackChannels() []string

func (*Report) GetTitle 

func (x *Report) GetTitle() string

func (*Report) ProtoMessage 

func (*Report) ProtoMessage()

func (*Report) ProtoReflect 

func (x *Report) ProtoReflect() protoreflect.Message

func (*Report) Reset 

func (x *Report) Reset()

func (*Report) String 

func (x *Report) String() string

type ReportListItem added in v0.9.0 

type ReportListItem struct {
	Name           string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Title          string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	CronExpression string `protobuf:"bytes,3,opt,name=cron_expression,json=cronExpression,proto3" json:"cron_expression,omitempty"`
	CronTimezone   string `protobuf:"bytes,4,opt,name=cron_timezone,json=cronTimezone,proto3" json:"cron_timezone,omitempty"` // (default UTC)
	// contains filtered or unexported fields
}

func (*ReportListItem) Descriptor deprecated added in v0.9.0 

func (*ReportListItem) Descriptor() ([]byte, []int)

Deprecated: Use ReportListItem.ProtoReflect.Descriptor instead.

func (*ReportListItem) GetCronExpression added in v0.9.0 

func (x *ReportListItem) GetCronExpression() string

func (*ReportListItem) GetCronTimezone added in v0.9.0 

func (x *ReportListItem) GetCronTimezone() string

func (*ReportListItem) GetName added in v0.9.0 

func (x *ReportListItem) GetName() string

func (*ReportListItem) GetTitle added in v0.9.0 

func (x *ReportListItem) GetTitle() string

func (*ReportListItem) ProtoMessage added in v0.9.0 

func (*ReportListItem) ProtoMessage()

func (*ReportListItem) ProtoReflect added in v0.9.0 

func (x *ReportListItem) ProtoReflect() protoreflect.Message

func (*ReportListItem) Reset added in v0.9.0 

func (x *ReportListItem) Reset()

func (*ReportListItem) String added in v0.9.0 

func (x *ReportListItem) String() string

type ReportQuery 

type ReportQuery struct {
	Name            string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Summarise       []int32        `protobuf:"varint,2,rep,packed,name=summarise,proto3" json:"summarise,omitempty"`
	Sql             string         `protobuf:"bytes,3,opt,name=sql,proto3" json:"sql,omitempty"`
	ValueProcessing []*ReportValue `protobuf:"bytes,4,rep,name=value_processing,json=valueProcessing,proto3" json:"value_processing,omitempty"`
	// contains filtered or unexported fields
}

func (*ReportQuery) Descriptor deprecated 

func (*ReportQuery) Descriptor() ([]byte, []int)

Deprecated: Use ReportQuery.ProtoReflect.Descriptor instead.

func (*ReportQuery) GetName 

func (x *ReportQuery) GetName() string

func (*ReportQuery) GetSql 

func (x *ReportQuery) GetSql() string

func (*ReportQuery) GetSummarise 

func (x *ReportQuery) GetSummarise() []int32

func (*ReportQuery) GetValueProcessing 

func (x *ReportQuery) GetValueProcessing() []*ReportValue

func (*ReportQuery) ProtoMessage 

func (*ReportQuery) ProtoMessage()

func (*ReportQuery) ProtoReflect 

func (x *ReportQuery) ProtoReflect() protoreflect.Message

func (*ReportQuery) Reset 

func (x *ReportQuery) Reset()

func (*ReportQuery) String 

func (x *ReportQuery) String() string

type ReportValue 

type ReportValue struct {
	Column     string   `protobuf:"bytes,1,opt,name=column,proto3" json:"column,omitempty"`
	Processors []string `protobuf:"bytes,2,rep,name=processors,proto3" json:"processors,omitempty"`
	// contains filtered or unexported fields
}

func (*ReportValue) Descriptor deprecated 

func (*ReportValue) Descriptor() ([]byte, []int)

Deprecated: Use ReportValue.ProtoReflect.Descriptor instead.

func (*ReportValue) GetColumn 

func (x *ReportValue) GetColumn() string

func (*ReportValue) GetProcessors 

func (x *ReportValue) GetProcessors() []string

func (*ReportValue) ProtoMessage 

func (*ReportValue) ProtoMessage()

func (*ReportValue) ProtoReflect 

func (x *ReportValue) ProtoReflect() protoreflect.Message

func (*ReportValue) Reset 

func (x *ReportValue) Reset()

func (*ReportValue) String 

func (x *ReportValue) String() string

type Reports 

type Reports interface {
	// List all reports.
	List(context.Context, *ListReportsRequest) (*ListReportsResponse, error)

	// Update or create a report.
	Update(context.Context, *UpdateReportRequest) (*UpdateReportResponse, error)

	// Get a report.
	Get(context.Context, *GetReportRequest) (*GetReportResponse, error)

	// Delete a report.
	Delete(context.Context, *DeleteReportRequest) (*DeleteReportResponse, error)

	// Run a report. This will run the report and return the results instead of
	// sending it to any outputs.
	Run(context.Context, *RunReportRequest) (*RunReportResponse, error)

	// Test a report by runing it without saving.
	Test(context.Context, *TestReportRequest) (*TestReportResponse, error)
}

func NewReportsJSONClient 

func NewReportsJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Reports

NewReportsJSONClient creates a JSON client that implements the Reports interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewReportsProtobufClient 

func NewReportsProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Reports

NewReportsProtobufClient creates a Protobuf client that implements the Reports interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type RestoreRequest added in v0.13.0 

type RestoreRequest struct {

	// UUID of the document to restore.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// DeleteRecordID for the specific instance of the document that was deleted.
	DeleteRecordId int64 `protobuf:"varint,2,opt,name=delete_record_id,json=deleteRecordId,proto3" json:"delete_record_id,omitempty"`
	// ACL that should be set for the restored document.
	Acl []*ACLEntry `protobuf:"bytes,3,rep,name=acl,proto3" json:"acl,omitempty"`
	// contains filtered or unexported fields
}

func (*RestoreRequest) Descriptor deprecated added in v0.13.0 

func (*RestoreRequest) Descriptor() ([]byte, []int)

Deprecated: Use RestoreRequest.ProtoReflect.Descriptor instead.

func (*RestoreRequest) GetAcl added in v0.13.0 

func (x *RestoreRequest) GetAcl() []*ACLEntry

func (*RestoreRequest) GetDeleteRecordId added in v0.13.0 

func (x *RestoreRequest) GetDeleteRecordId() int64

func (*RestoreRequest) GetUuid added in v0.13.0 

func (x *RestoreRequest) GetUuid() string

func (*RestoreRequest) ProtoMessage added in v0.13.0 

func (*RestoreRequest) ProtoMessage()

func (*RestoreRequest) ProtoReflect added in v0.13.0 

func (x *RestoreRequest) ProtoReflect() protoreflect.Message

func (*RestoreRequest) Reset added in v0.13.0 

func (x *RestoreRequest) Reset()

func (*RestoreRequest) String added in v0.13.0 

func (x *RestoreRequest) String() string

type RestoreResponse added in v0.13.0 

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

func (*RestoreResponse) Descriptor deprecated added in v0.13.0 

func (*RestoreResponse) Descriptor() ([]byte, []int)

Deprecated: Use RestoreResponse.ProtoReflect.Descriptor instead.

func (*RestoreResponse) ProtoMessage added in v0.13.0 

func (*RestoreResponse) ProtoMessage()

func (*RestoreResponse) ProtoReflect added in v0.13.0 

func (x *RestoreResponse) ProtoReflect() protoreflect.Message

func (*RestoreResponse) Reset added in v0.13.0 

func (x *RestoreResponse) Reset()

func (*RestoreResponse) String added in v0.13.0 

func (x *RestoreResponse) String() string

type RunReportRequest 

type RunReportRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*RunReportRequest) Descriptor deprecated 

func (*RunReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunReportRequest.ProtoReflect.Descriptor instead.

func (*RunReportRequest) GetName 

func (x *RunReportRequest) GetName() string

func (*RunReportRequest) ProtoMessage 

func (*RunReportRequest) ProtoMessage()

func (*RunReportRequest) ProtoReflect 

func (x *RunReportRequest) ProtoReflect() protoreflect.Message

func (*RunReportRequest) Reset 

func (x *RunReportRequest) Reset()

func (*RunReportRequest) String 

func (x *RunReportRequest) String() string

type RunReportResponse 

type RunReportResponse struct {
	Tables      []string `protobuf:"bytes,1,rep,name=tables,proto3" json:"tables,omitempty"`
	Spreadsheet []byte   `protobuf:"bytes,2,opt,name=spreadsheet,proto3" json:"spreadsheet,omitempty"`
	// contains filtered or unexported fields
}

func (*RunReportResponse) Descriptor deprecated 

func (*RunReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use RunReportResponse.ProtoReflect.Descriptor instead.

func (*RunReportResponse) GetSpreadsheet 

func (x *RunReportResponse) GetSpreadsheet() []byte

func (*RunReportResponse) GetTables 

func (x *RunReportResponse) GetTables() []string

func (*RunReportResponse) ProtoMessage 

func (*RunReportResponse) ProtoMessage()

func (*RunReportResponse) ProtoReflect 

func (x *RunReportResponse) ProtoReflect() protoreflect.Message

func (*RunReportResponse) Reset 

func (x *RunReportResponse) Reset()

func (*RunReportResponse) String 

func (x *RunReportResponse) String() string

type Schema 

type Schema struct {
	Name    string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	Spec    string `protobuf:"bytes,3,opt,name=spec,proto3" json:"spec,omitempty"`
	// contains filtered or unexported fields
}

func (*Schema) Descriptor deprecated 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetName 

func (x *Schema) GetName() string

func (*Schema) GetSpec 

func (x *Schema) GetSpec() string

func (*Schema) GetVersion 

func (x *Schema) GetVersion() string

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset 

func (x *Schema) Reset()

func (*Schema) String 

func (x *Schema) String() string

type Schemas 

type Schemas interface {
	// Register register a new validation schema version.
	Register(context.Context, *RegisterSchemaRequest) (*RegisterSchemaResponse, error)

	// SetActive activates schema versions.
	SetActive(context.Context, *SetActiveSchemaRequest) (*SetActiveSchemaResponse, error)

	// Get retrieves a schema.
	Get(context.Context, *GetSchemaRequest) (*GetSchemaResponse, error)

	// GetAllActiveSchemas returns the currently active schemas.
	GetAllActive(context.Context, *GetAllActiveSchemasRequest) (*GetAllActiveSchemasResponse, error)

	// RegisterMetaType registers a type that can be used for meta documents.
	RegisterMetaType(context.Context, *RegisterMetaTypeRequest) (*RegisterMetaTypeResponse, error)

	// RegisterMetaTypeUse registers a meta type for use with a main type.
	RegisterMetaTypeUse(context.Context, *RegisterMetaTypeUseRequest) (*RegisterMetaTypeUseResponse, error)

	// GetDeprecations lists all deprecations.
	GetDeprecations(context.Context, *GetDeprecationsRequest) (*GetDeprecationsResponse, error)

	// UpdateDeprecation creates or updates a deprecation.
	UpdateDeprecation(context.Context, *UpdateDeprecationRequest) (*UpdateDeprecationResponse, error)
}

func NewSchemasJSONClient 

func NewSchemasJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Schemas

NewSchemasJSONClient creates a JSON client that implements the Schemas interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewSchemasProtobufClient 

func NewSchemasProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Schemas

NewSchemasProtobufClient creates a Protobuf client that implements the Schemas interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type SetActiveSchemaRequest 

type SetActiveSchemaRequest struct {

	// Name is the name of the schema to activate or deactivate, required.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the schema to activate, required when activating a new version.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Deactivate is used to disable a schema, activate new schema versions
	// instead if you want to start using a new version.
	Deactivate bool `protobuf:"varint,3,opt,name=deactivate,proto3" json:"deactivate,omitempty"`
	// contains filtered or unexported fields
}

func (*SetActiveSchemaRequest) Descriptor deprecated 

func (*SetActiveSchemaRequest) Descriptor() ([]byte, []int)

Deprecated: Use SetActiveSchemaRequest.ProtoReflect.Descriptor instead.

func (*SetActiveSchemaRequest) GetDeactivate 

func (x *SetActiveSchemaRequest) GetDeactivate() bool

func (*SetActiveSchemaRequest) GetName 

func (x *SetActiveSchemaRequest) GetName() string

func (*SetActiveSchemaRequest) GetVersion 

func (x *SetActiveSchemaRequest) GetVersion() string

func (*SetActiveSchemaRequest) ProtoMessage 

func (*SetActiveSchemaRequest) ProtoMessage()

func (*SetActiveSchemaRequest) ProtoReflect 

func (x *SetActiveSchemaRequest) ProtoReflect() protoreflect.Message

func (*SetActiveSchemaRequest) Reset 

func (x *SetActiveSchemaRequest) Reset()

func (*SetActiveSchemaRequest) String 

func (x *SetActiveSchemaRequest) String() string

type SetActiveSchemaResponse 

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

func (*SetActiveSchemaResponse) Descriptor deprecated 

func (*SetActiveSchemaResponse) Descriptor() ([]byte, []int)

Deprecated: Use SetActiveSchemaResponse.ProtoReflect.Descriptor instead.

func (*SetActiveSchemaResponse) ProtoMessage 

func (*SetActiveSchemaResponse) ProtoMessage()

func (*SetActiveSchemaResponse) ProtoReflect 

func (x *SetActiveSchemaResponse) ProtoReflect() protoreflect.Message

func (*SetActiveSchemaResponse) Reset 

func (x *SetActiveSchemaResponse) Reset()

func (*SetActiveSchemaResponse) String 

func (x *SetActiveSchemaResponse) String() string

type Status 

type Status struct {

	// ID of the status.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Version of the document that the status refers to.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Creator of the status.
	Creator string `protobuf:"bytes,3,opt,name=creator,proto3" json:"creator,omitempty"`
	// Created timestamp is the RFC3339 timestamp for when the status was created.
	Created string `protobuf:"bytes,4,opt,name=created,proto3" json:"created,omitempty"`
	// Meta data for the status.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// MetaDocumentVersion is the version the meta document had at the time the
	// status was set.
	MetaDocVersion int64 `protobuf:"varint,6,opt,name=meta_doc_version,json=metaDocVersion,proto3" json:"meta_doc_version,omitempty"`
	// contains filtered or unexported fields
}

func (*Status) Descriptor deprecated 

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCreated 

func (x *Status) GetCreated() string

func (*Status) GetCreator 

func (x *Status) GetCreator() string

func (*Status) GetId 

func (x *Status) GetId() int64

func (*Status) GetMeta 

func (x *Status) GetMeta() map[string]string

func (*Status) GetMetaDocVersion added in v0.13.0 

func (x *Status) GetMetaDocVersion() int64

func (*Status) GetVersion 

func (x *Status) GetVersion() int64

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

type StatusOverviewItem added in v0.12.0 

type StatusOverviewItem struct {

	// UUID of the document.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Version the document is at.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Modified timestamp is the RFC3339 timestamp for the last change that
	// affected the document.
	Modified string `protobuf:"bytes,3,opt,name=modified,proto3" json:"modified,omitempty"`
	// Heads are the last statuses.
	Heads map[string]*Status `` /* 151-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*StatusOverviewItem) Descriptor deprecated added in v0.12.0 

func (*StatusOverviewItem) Descriptor() ([]byte, []int)

Deprecated: Use StatusOverviewItem.ProtoReflect.Descriptor instead.

func (*StatusOverviewItem) GetHeads added in v0.12.0 

func (x *StatusOverviewItem) GetHeads() map[string]*Status

func (*StatusOverviewItem) GetModified added in v0.12.0 

func (x *StatusOverviewItem) GetModified() string

func (*StatusOverviewItem) GetUuid added in v0.12.0 

func (x *StatusOverviewItem) GetUuid() string

func (*StatusOverviewItem) GetVersion added in v0.12.0 

func (x *StatusOverviewItem) GetVersion() int64

func (*StatusOverviewItem) ProtoMessage added in v0.12.0 

func (*StatusOverviewItem) ProtoMessage()

func (*StatusOverviewItem) ProtoReflect added in v0.12.0 

func (x *StatusOverviewItem) ProtoReflect() protoreflect.Message

func (*StatusOverviewItem) Reset added in v0.12.0 

func (x *StatusOverviewItem) Reset()

func (*StatusOverviewItem) String added in v0.12.0 

func (x *StatusOverviewItem) String() string

type StatusRule 

type StatusRule struct {

	// Type that the status rule applies to.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Name of the rule.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the rule.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// AccessRule whether this rule acts as access control.
	AccessRule bool `protobuf:"varint,4,opt,name=access_rule,json=accessRule,proto3" json:"access_rule,omitempty"`
	// AppliesTo is a list of statuses that this rule applies to.
	AppliesTo []string `protobuf:"bytes,5,rep,name=applies_to,json=appliesTo,proto3" json:"applies_to,omitempty"`
	// Expression that is evaluated for the rule.
	Expression string `protobuf:"bytes,7,opt,name=expression,proto3" json:"expression,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusRule) Descriptor deprecated 

func (*StatusRule) Descriptor() ([]byte, []int)

Deprecated: Use StatusRule.ProtoReflect.Descriptor instead.

func (*StatusRule) GetAccessRule 

func (x *StatusRule) GetAccessRule() bool

func (*StatusRule) GetAppliesTo 

func (x *StatusRule) GetAppliesTo() []string

func (*StatusRule) GetDescription 

func (x *StatusRule) GetDescription() string

func (*StatusRule) GetExpression 

func (x *StatusRule) GetExpression() string

func (*StatusRule) GetName 

func (x *StatusRule) GetName() string

func (*StatusRule) GetType added in v0.16.0 

func (x *StatusRule) GetType() string

func (*StatusRule) ProtoMessage 

func (*StatusRule) ProtoMessage()

func (*StatusRule) ProtoReflect 

func (x *StatusRule) ProtoReflect() protoreflect.Message

func (*StatusRule) Reset 

func (x *StatusRule) Reset()

func (*StatusRule) String 

func (x *StatusRule) String() string

type StatusUpdate 

type StatusUpdate struct {

	// Name of the status to set.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version to set the status for. Set to -1 to signal that the status no
	// longer is valid for the document. Optional if part of a document update
	// request as it then will default to the version being written.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Meta data to include with the status update.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// IfMatch is used for optimistic locks. Set to the status id that you require
	// to be the current one for the status to be set, or -1 to only perform the
	// update if the status hasn't previously been set.
	IfMatch int64 `protobuf:"varint,4,opt,name=if_match,json=ifMatch,proto3" json:"if_match,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusUpdate) Descriptor deprecated 

func (*StatusUpdate) Descriptor() ([]byte, []int)

Deprecated: Use StatusUpdate.ProtoReflect.Descriptor instead.

func (*StatusUpdate) GetIfMatch 

func (x *StatusUpdate) GetIfMatch() int64

func (*StatusUpdate) GetMeta 

func (x *StatusUpdate) GetMeta() map[string]string

func (*StatusUpdate) GetName 

func (x *StatusUpdate) GetName() string

func (*StatusUpdate) GetVersion 

func (x *StatusUpdate) GetVersion() int64

func (*StatusUpdate) ProtoMessage 

func (*StatusUpdate) ProtoMessage()

func (*StatusUpdate) ProtoReflect 

func (x *StatusUpdate) ProtoReflect() protoreflect.Message

func (*StatusUpdate) Reset 

func (x *StatusUpdate) Reset()

func (*StatusUpdate) String 

func (x *StatusUpdate) String() string

type TestReportRequest 

type TestReportRequest struct {
	Report *Report `protobuf:"bytes,1,opt,name=report,proto3" json:"report,omitempty"`
	// contains filtered or unexported fields
}

func (*TestReportRequest) Descriptor deprecated 

func (*TestReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use TestReportRequest.ProtoReflect.Descriptor instead.

func (*TestReportRequest) GetReport 

func (x *TestReportRequest) GetReport() *Report

func (*TestReportRequest) ProtoMessage 

func (*TestReportRequest) ProtoMessage()

func (*TestReportRequest) ProtoReflect 

func (x *TestReportRequest) ProtoReflect() protoreflect.Message

func (*TestReportRequest) Reset 

func (x *TestReportRequest) Reset()

func (*TestReportRequest) String 

func (x *TestReportRequest) String() string

type TestReportResponse 

type TestReportResponse struct {
	Tables      []string `protobuf:"bytes,1,rep,name=tables,proto3" json:"tables,omitempty"`
	Spreadsheet []byte   `protobuf:"bytes,2,opt,name=spreadsheet,proto3" json:"spreadsheet,omitempty"`
	// contains filtered or unexported fields
}

func (*TestReportResponse) Descriptor deprecated 

func (*TestReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use TestReportResponse.ProtoReflect.Descriptor instead.

func (*TestReportResponse) GetSpreadsheet 

func (x *TestReportResponse) GetSpreadsheet() []byte

func (*TestReportResponse) GetTables 

func (x *TestReportResponse) GetTables() []string

func (*TestReportResponse) ProtoMessage 

func (*TestReportResponse) ProtoMessage()

func (*TestReportResponse) ProtoReflect 

func (x *TestReportResponse) ProtoReflect() protoreflect.Message

func (*TestReportResponse) Reset 

func (x *TestReportResponse) Reset()

func (*TestReportResponse) String 

func (x *TestReportResponse) String() string

type TwirpServer 

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}

TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.

func NewDocumentsServer 

func NewDocumentsServer(svc Documents, opts ...interface{}) TwirpServer

NewDocumentsServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

func NewMetricsServer 

func NewMetricsServer(svc Metrics, opts ...interface{}) TwirpServer

NewMetricsServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

func NewReportsServer 

func NewReportsServer(svc Reports, opts ...interface{}) TwirpServer

NewReportsServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

func NewSchemasServer 

func NewSchemasServer(svc Schemas, opts ...interface{}) TwirpServer

NewSchemasServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

func NewWorkflowsServer 

func NewWorkflowsServer(svc Workflows, opts ...interface{}) TwirpServer

NewWorkflowsServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

type UnlockRequest added in v0.6.0 

type UnlockRequest struct {

	// UUID of the document to unlock
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Lock token in UUID format.
	Token string `protobuf:"bytes,2,opt,name=token,proto3" json:"token,omitempty"`
	// contains filtered or unexported fields
}

func (*UnlockRequest) Descriptor deprecated added in v0.6.0 

func (*UnlockRequest) Descriptor() ([]byte, []int)

Deprecated: Use UnlockRequest.ProtoReflect.Descriptor instead.

func (*UnlockRequest) GetToken added in v0.6.0 

func (x *UnlockRequest) GetToken() string

func (*UnlockRequest) GetUuid added in v0.6.0 

func (x *UnlockRequest) GetUuid() string

func (*UnlockRequest) ProtoMessage added in v0.6.0 

func (*UnlockRequest) ProtoMessage()

func (*UnlockRequest) ProtoReflect added in v0.6.0 

func (x *UnlockRequest) ProtoReflect() protoreflect.Message

func (*UnlockRequest) Reset added in v0.6.0 

func (x *UnlockRequest) Reset()

func (*UnlockRequest) String added in v0.6.0 

func (x *UnlockRequest) String() string

type UnlockResponse added in v0.6.0 

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

func (*UnlockResponse) Descriptor deprecated added in v0.6.0 

func (*UnlockResponse) Descriptor() ([]byte, []int)

Deprecated: Use UnlockResponse.ProtoReflect.Descriptor instead.

func (*UnlockResponse) ProtoMessage added in v0.6.0 

func (*UnlockResponse) ProtoMessage()

func (*UnlockResponse) ProtoReflect added in v0.6.0 

func (x *UnlockResponse) ProtoReflect() protoreflect.Message

func (*UnlockResponse) Reset added in v0.6.0 

func (x *UnlockResponse) Reset()

func (*UnlockResponse) String added in v0.6.0 

func (x *UnlockResponse) String() string

type UpdateDeprecationRequest added in v0.11.0 

type UpdateDeprecationRequest struct {
	Deprecation *Deprecation `protobuf:"bytes,1,opt,name=deprecation,proto3" json:"deprecation,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateDeprecationRequest) Descriptor deprecated added in v0.11.0 

func (*UpdateDeprecationRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDeprecationRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeprecationRequest) GetDeprecation added in v0.11.0 

func (x *UpdateDeprecationRequest) GetDeprecation() *Deprecation

func (*UpdateDeprecationRequest) ProtoMessage added in v0.11.0 

func (*UpdateDeprecationRequest) ProtoMessage()

func (*UpdateDeprecationRequest) ProtoReflect added in v0.11.0 

func (x *UpdateDeprecationRequest) ProtoReflect() protoreflect.Message

func (*UpdateDeprecationRequest) Reset added in v0.11.0 

func (x *UpdateDeprecationRequest) Reset()

func (*UpdateDeprecationRequest) String added in v0.11.0 

func (x *UpdateDeprecationRequest) String() string

type UpdateDeprecationResponse added in v0.11.0 

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

func (*UpdateDeprecationResponse) Descriptor deprecated added in v0.11.0 

func (*UpdateDeprecationResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDeprecationResponse.ProtoReflect.Descriptor instead.

func (*UpdateDeprecationResponse) ProtoMessage added in v0.11.0 

func (*UpdateDeprecationResponse) ProtoMessage()

func (*UpdateDeprecationResponse) ProtoReflect added in v0.11.0 

func (x *UpdateDeprecationResponse) ProtoReflect() protoreflect.Message

func (*UpdateDeprecationResponse) Reset added in v0.11.0 

func (x *UpdateDeprecationResponse) Reset()

func (*UpdateDeprecationResponse) String added in v0.11.0 

func (x *UpdateDeprecationResponse) String() string

type UpdatePermissionsRequest 

type UpdatePermissionsRequest struct {

	// UUID of the document to update permissions for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Set (upsert based on URI) this list of ACL entries.
	List []*ACLEntry `protobuf:"bytes,2,rep,name=list,proto3" json:"list,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdatePermissionsRequest) Descriptor deprecated 

func (*UpdatePermissionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdatePermissionsRequest.ProtoReflect.Descriptor instead.

func (*UpdatePermissionsRequest) GetList 

func (x *UpdatePermissionsRequest) GetList() []*ACLEntry

func (*UpdatePermissionsRequest) GetUuid 

func (x *UpdatePermissionsRequest) GetUuid() string

func (*UpdatePermissionsRequest) ProtoMessage 

func (*UpdatePermissionsRequest) ProtoMessage()

func (*UpdatePermissionsRequest) ProtoReflect 

func (x *UpdatePermissionsRequest) ProtoReflect() protoreflect.Message

func (*UpdatePermissionsRequest) Reset 

func (x *UpdatePermissionsRequest) Reset()

func (*UpdatePermissionsRequest) String 

func (x *UpdatePermissionsRequest) String() string

type UpdatePermissionsResponse 

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

func (*UpdatePermissionsResponse) Descriptor deprecated 

func (*UpdatePermissionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdatePermissionsResponse.ProtoReflect.Descriptor instead.

func (*UpdatePermissionsResponse) ProtoMessage 

func (*UpdatePermissionsResponse) ProtoMessage()

func (*UpdatePermissionsResponse) ProtoReflect 

func (x *UpdatePermissionsResponse) ProtoReflect() protoreflect.Message

func (*UpdatePermissionsResponse) Reset 

func (x *UpdatePermissionsResponse) Reset()

func (*UpdatePermissionsResponse) String 

func (x *UpdatePermissionsResponse) String() string

type UpdateReportRequest 

type UpdateReportRequest struct {
	Report  *Report `protobuf:"bytes,1,opt,name=report,proto3" json:"report,omitempty"`
	Enabled bool    `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateReportRequest) Descriptor deprecated 

func (*UpdateReportRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateReportRequest.ProtoReflect.Descriptor instead.

func (*UpdateReportRequest) GetEnabled 

func (x *UpdateReportRequest) GetEnabled() bool

func (*UpdateReportRequest) GetReport 

func (x *UpdateReportRequest) GetReport() *Report

func (*UpdateReportRequest) ProtoMessage 

func (*UpdateReportRequest) ProtoMessage()

func (*UpdateReportRequest) ProtoReflect 

func (x *UpdateReportRequest) ProtoReflect() protoreflect.Message

func (*UpdateReportRequest) Reset 

func (x *UpdateReportRequest) Reset()

func (*UpdateReportRequest) String 

func (x *UpdateReportRequest) String() string

type UpdateReportResponse 

type UpdateReportResponse struct {
	NextExecution string `protobuf:"bytes,1,opt,name=next_execution,json=nextExecution,proto3" json:"next_execution,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateReportResponse) Descriptor deprecated 

func (*UpdateReportResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateReportResponse.ProtoReflect.Descriptor instead.

func (*UpdateReportResponse) GetNextExecution 

func (x *UpdateReportResponse) GetNextExecution() string

func (*UpdateReportResponse) ProtoMessage 

func (*UpdateReportResponse) ProtoMessage()

func (*UpdateReportResponse) ProtoReflect 

func (x *UpdateReportResponse) ProtoReflect() protoreflect.Message

func (*UpdateReportResponse) Reset 

func (x *UpdateReportResponse) Reset()

func (*UpdateReportResponse) String 

func (x *UpdateReportResponse) String() string

type UpdateRequest 

type UpdateRequest struct {

	// UUID of the document to update.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Document version to create.
	Document *newsdoc.Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// Meta data to associate with the document version.
	Meta map[string]string `` /* 149-byte string literal not displayed */
	// IfMatch is used for optimistic locks. Set to the version that you require
	// to be the current one for the update to be performed, or -1 to only perform
	// the update if the document doesn't already exist.
	IfMatch int64 `protobuf:"varint,4,opt,name=if_match,json=ifMatch,proto3" json:"if_match,omitempty"`
	// Status updates to perform.
	Status []*StatusUpdate `protobuf:"bytes,5,rep,name=status,proto3" json:"status,omitempty"`
	// ACL is an ACL list controlling access to the document.
	Acl []*ACLEntry `protobuf:"bytes,6,rep,name=acl,proto3" json:"acl,omitempty"`
	// ImportDirective can be used to preserve timestamps and authorship
	// information from originating systems, but requires the "import_directive"
	// scope for use.
	ImportDirective *ImportDirective `protobuf:"bytes,7,opt,name=import_directive,json=importDirective,proto3" json:"import_directive,omitempty"`
	// LockToken is used for explicit pessimistic locking.
	LockToken string `protobuf:"bytes,8,opt,name=lockToken,proto3" json:"lockToken,omitempty"`
	// UpdateMetaDocument can be set to true to update the meta document instead
	// of the document identified by the UUID.
	UpdateMetaDocument bool `protobuf:"varint,9,opt,name=update_meta_document,json=updateMetaDocument,proto3" json:"update_meta_document,omitempty"`
	// contains filtered or unexported fields
}

UpdateRequest creates a new document version and/or sets statuses and ACLs for a document. The update is transactional will fail or succed as a whole.

If the document fails validation an "invalid_argument" error will be returned with the number of errors as meta "err_count" and the individual errors as "0", "1", "2"... Use the Validate method to get th errors as structured data.

func (*UpdateRequest) Descriptor deprecated 

func (*UpdateRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetAcl 

func (x *UpdateRequest) GetAcl() []*ACLEntry

func (*UpdateRequest) GetDocument 

func (x *UpdateRequest) GetDocument() *newsdoc.Document

func (*UpdateRequest) GetIfMatch 

func (x *UpdateRequest) GetIfMatch() int64

func (*UpdateRequest) GetImportDirective 

func (x *UpdateRequest) GetImportDirective() *ImportDirective

func (*UpdateRequest) GetLockToken added in v0.6.0 

func (x *UpdateRequest) GetLockToken() string

func (*UpdateRequest) GetMeta 

func (x *UpdateRequest) GetMeta() map[string]string

func (*UpdateRequest) GetStatus 

func (x *UpdateRequest) GetStatus() []*StatusUpdate

func (*UpdateRequest) GetUpdateMetaDocument added in v0.10.0 

func (x *UpdateRequest) GetUpdateMetaDocument() bool

func (*UpdateRequest) GetUuid 

func (x *UpdateRequest) GetUuid() string

func (*UpdateRequest) ProtoMessage 

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect 

func (x *UpdateRequest) ProtoReflect() protoreflect.Message

func (*UpdateRequest) Reset 

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String 

func (x *UpdateRequest) String() string

type UpdateResponse 

type UpdateResponse struct {
	Version int64  `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	Uuid    string `protobuf:"bytes,2,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// contains filtered or unexported fields
}

UpdateResponse describes the result of an update request.

func (*UpdateResponse) Descriptor deprecated 

func (*UpdateResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) GetUuid added in v0.10.0 

func (x *UpdateResponse) GetUuid() string

func (*UpdateResponse) GetVersion 

func (x *UpdateResponse) GetVersion() int64

func (*UpdateResponse) ProtoMessage 

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect 

func (x *UpdateResponse) ProtoReflect() protoreflect.Message

func (*UpdateResponse) Reset 

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String 

func (x *UpdateResponse) String() string

type UpdateStatusRequest 

type UpdateStatusRequest struct {

	// Type that the status is valid for.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Name of the status.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Disabled disables the status so that it cannot be used when setting new
	// statuses.
	Disabled bool `protobuf:"varint,3,opt,name=disabled,proto3" json:"disabled,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateStatusRequest) Descriptor deprecated 

func (*UpdateStatusRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateStatusRequest.ProtoReflect.Descriptor instead.

func (*UpdateStatusRequest) GetDisabled 

func (x *UpdateStatusRequest) GetDisabled() bool

func (*UpdateStatusRequest) GetName 

func (x *UpdateStatusRequest) GetName() string

func (*UpdateStatusRequest) GetType added in v0.16.0 

func (x *UpdateStatusRequest) GetType() string

func (*UpdateStatusRequest) ProtoMessage 

func (*UpdateStatusRequest) ProtoMessage()

func (*UpdateStatusRequest) ProtoReflect 

func (x *UpdateStatusRequest) ProtoReflect() protoreflect.Message

func (*UpdateStatusRequest) Reset 

func (x *UpdateStatusRequest) Reset()

func (*UpdateStatusRequest) String 

func (x *UpdateStatusRequest) String() string

type UpdateStatusResponse 

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

func (*UpdateStatusResponse) Descriptor deprecated 

func (*UpdateStatusResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateStatusResponse.ProtoReflect.Descriptor instead.

func (*UpdateStatusResponse) ProtoMessage 

func (*UpdateStatusResponse) ProtoMessage()

func (*UpdateStatusResponse) ProtoReflect 

func (x *UpdateStatusResponse) ProtoReflect() protoreflect.Message

func (*UpdateStatusResponse) Reset 

func (x *UpdateStatusResponse) Reset()

func (*UpdateStatusResponse) String 

func (x *UpdateStatusResponse) String() string

type ValidateRequest 

type ValidateRequest struct {
	Document *newsdoc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidateRequest) Descriptor deprecated 

func (*ValidateRequest) Descriptor() ([]byte, []int)

Deprecated: Use ValidateRequest.ProtoReflect.Descriptor instead.

func (*ValidateRequest) GetDocument 

func (x *ValidateRequest) GetDocument() *newsdoc.Document

func (*ValidateRequest) ProtoMessage 

func (*ValidateRequest) ProtoMessage()

func (*ValidateRequest) ProtoReflect 

func (x *ValidateRequest) ProtoReflect() protoreflect.Message

func (*ValidateRequest) Reset 

func (x *ValidateRequest) Reset()

func (*ValidateRequest) String 

func (x *ValidateRequest) String() string

type ValidateResponse 

type ValidateResponse struct {
	Errors []*ValidationResult `protobuf:"bytes,1,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidateResponse) Descriptor deprecated 

func (*ValidateResponse) Descriptor() ([]byte, []int)

Deprecated: Use ValidateResponse.ProtoReflect.Descriptor instead.

func (*ValidateResponse) GetErrors 

func (x *ValidateResponse) GetErrors() []*ValidationResult

func (*ValidateResponse) ProtoMessage 

func (*ValidateResponse) ProtoMessage()

func (*ValidateResponse) ProtoReflect 

func (x *ValidateResponse) ProtoReflect() protoreflect.Message

func (*ValidateResponse) Reset 

func (x *ValidateResponse) Reset()

func (*ValidateResponse) String 

func (x *ValidateResponse) String() string

type ValidationResult 

type ValidationResult struct {
	Entity []*EntityRef `protobuf:"bytes,1,rep,name=entity,proto3" json:"entity,omitempty"`
	Error  string       `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidationResult) Descriptor deprecated 

func (*ValidationResult) Descriptor() ([]byte, []int)

Deprecated: Use ValidationResult.ProtoReflect.Descriptor instead.

func (*ValidationResult) GetEntity 

func (x *ValidationResult) GetEntity() []*EntityRef

func (*ValidationResult) GetError 

func (x *ValidationResult) GetError() string

func (*ValidationResult) ProtoMessage 

func (*ValidationResult) ProtoMessage()

func (*ValidationResult) ProtoReflect 

func (x *ValidationResult) ProtoReflect() protoreflect.Message

func (*ValidationResult) Reset 

func (x *ValidationResult) Reset()

func (*ValidationResult) String 

func (x *ValidationResult) String() string

type WorkflowStatus 

type WorkflowStatus struct {
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowStatus) Descriptor deprecated 

func (*WorkflowStatus) Descriptor() ([]byte, []int)

Deprecated: Use WorkflowStatus.ProtoReflect.Descriptor instead.

func (*WorkflowStatus) GetName 

func (x *WorkflowStatus) GetName() string

func (*WorkflowStatus) GetType added in v0.16.0 

func (x *WorkflowStatus) GetType() string

func (*WorkflowStatus) ProtoMessage 

func (*WorkflowStatus) ProtoMessage()

func (*WorkflowStatus) ProtoReflect 

func (x *WorkflowStatus) ProtoReflect() protoreflect.Message

func (*WorkflowStatus) Reset 

func (x *WorkflowStatus) Reset()

func (*WorkflowStatus) String 

func (x *WorkflowStatus) String() string

type Workflows 

type Workflows interface {
	// UpdateStatus creates or updates a status that can be used for documents.
	UpdateStatus(context.Context, *UpdateStatusRequest) (*UpdateStatusResponse, error)

	// GetStatuses lists all enabled statuses.
	GetStatuses(context.Context, *GetStatusesRequest) (*GetStatusesResponse, error)

	// CreateStatusRule creates or updates a status rule that should be applied
	// when setting statuses.
	CreateStatusRule(context.Context, *CreateStatusRuleRequest) (*CreateStatusRuleResponse, error)

	// DeleteStatusRule removes a status rule.
	DeleteStatusRule(context.Context, *DeleteStatusRuleRequest) (*DeleteStatusRuleResponse, error)

	// GetStatusRules returns all status rules.
	GetStatusRules(context.Context, *GetStatusRulesRequest) (*GetStatusRulesResponse, error)
}

func NewWorkflowsJSONClient 

func NewWorkflowsJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Workflows

NewWorkflowsJSONClient creates a JSON client that implements the Workflows interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewWorkflowsProtobufClient 

func NewWorkflowsProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Workflows

NewWorkflowsProtobufClient creates a Protobuf client that implements the Workflows interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.