repository

package
v0.22.1 Latest Latest
Warning

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

Go to latest
Published: Apr 13, 2026 License: MIT Imports: 20 Imported by: 8

README

These are the services that the Elephant repository provides.

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 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 (
	SchemaActivation_name = map[int32]string{
		0: "ACTIVATION_UNKNOWN",
		1: "ACTIVATION_ACTIVE",
		2: "ACTIVATION_PENDING",
		3: "ACTIVATION_DEACTIVATED",
	}
	SchemaActivation_value = map[string]int32{
		"ACTIVATION_UNKNOWN":     0,
		"ACTIVATION_ACTIVE":      1,
		"ACTIVATION_PENDING":     2,
		"ACTIVATION_DEACTIVATED": 3,
	}
)

Enum value maps for SchemaActivation.

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 (
	FilterOperator_name = map[int32]string{
		0: "FILTER_OP_UNKNOWN",
		1: "FILTER_OP_ANY",
		2: "FILTER_OP_ALL",
		3: "FILTER_OP_NONE",
	}
	FilterOperator_value = map[string]int32{
		"FILTER_OP_UNKNOWN": 0,
		"FILTER_OP_ANY":     1,
		"FILTER_OP_ALL":     2,
		"FILTER_OP_NONE":    3,
	}
)

Enum value maps for FilterOperator.

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 AttachmentDetails added in v0.17.18

type AttachmentDetails struct {

	// Document is the UUID of the document the object is attached to.
	Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Name of the attachment.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Version of the attachment.
	Version int64 `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// DownloadLink that can be used to fetch the object contents, if requested.
	DownloadLink string `protobuf:"bytes,4,opt,name=download_link,json=downloadLink,proto3" json:"download_link,omitempty"`
	// Filename is the name of the file the object represents.
	Filename string `protobuf:"bytes,5,opt,name=filename,proto3" json:"filename,omitempty"`
	// ContentType is the MIME type of the object.
	ContentType string `protobuf:"bytes,6,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// contains filtered or unexported fields
}

func (*AttachmentDetails) Descriptor deprecated added in v0.17.18

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

Deprecated: Use AttachmentDetails.ProtoReflect.Descriptor instead.

func (*AttachmentDetails) GetContentType added in v0.17.18

func (x *AttachmentDetails) GetContentType() string

func (*AttachmentDetails) GetDocument added in v0.17.18

func (x *AttachmentDetails) GetDocument() string
func (x *AttachmentDetails) GetDownloadLink() string

func (*AttachmentDetails) GetFilename added in v0.17.18

func (x *AttachmentDetails) GetFilename() string

func (*AttachmentDetails) GetName added in v0.17.18

func (x *AttachmentDetails) GetName() string

func (*AttachmentDetails) GetVersion added in v0.17.18

func (x *AttachmentDetails) GetVersion() int64

func (*AttachmentDetails) ProtoMessage added in v0.17.18

func (*AttachmentDetails) ProtoMessage()

func (*AttachmentDetails) ProtoReflect added in v0.17.18

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

func (*AttachmentDetails) Reset added in v0.17.18

func (x *AttachmentDetails) Reset()

func (*AttachmentDetails) String added in v0.17.18

func (x *AttachmentDetails) String() string

type AttachmentRef added in v0.17.18

type AttachmentRef struct {

	// Name of the attachment.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Version is the current version of the attachment.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*AttachmentRef) Descriptor deprecated added in v0.17.18

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

Deprecated: Use AttachmentRef.ProtoReflect.Descriptor instead.

func (*AttachmentRef) GetName added in v0.17.18

func (x *AttachmentRef) GetName() string

func (*AttachmentRef) GetVersion added in v0.17.18

func (x *AttachmentRef) GetVersion() int64

func (*AttachmentRef) ProtoMessage added in v0.17.18

func (*AttachmentRef) ProtoMessage()

func (*AttachmentRef) ProtoReflect added in v0.17.18

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

func (*AttachmentRef) Reset added in v0.17.18

func (x *AttachmentRef) Reset()

func (*AttachmentRef) String added in v0.17.18

func (x *AttachmentRef) 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"`
	// UUID of the loaded document.
	Uuid string `protobuf:"bytes,3,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Subset is the extracted subset of the document.
	Subset []*ExtractedValues `protobuf:"bytes,4,rep,name=subset,proto3" json:"subset,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) GetSubset added in v0.21.0

func (x *BulkGetItem) GetSubset() []*ExtractedValues

func (*BulkGetItem) GetUuid added in v0.21.0

func (x *BulkGetItem) GetUuid() string

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"`
	// Subset returns a subset of the documents as specified by a list of newsdoc
	// value extractors.
	Subset []string `protobuf:"bytes,2,rep,name=subset,proto3" json:"subset,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) GetSubset added in v0.21.0

func (x *BulkGetRequest) GetSubset() []string

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 ConfigureTypeRequest added in v0.19.0

type ConfigureTypeRequest struct {

	// Type to configure.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Configuration for the type.
	Configuration *TypeConfiguration `protobuf:"bytes,2,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigureTypeRequest) Descriptor deprecated added in v0.19.0

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

Deprecated: Use ConfigureTypeRequest.ProtoReflect.Descriptor instead.

func (*ConfigureTypeRequest) GetConfiguration added in v0.19.0

func (x *ConfigureTypeRequest) GetConfiguration() *TypeConfiguration

func (*ConfigureTypeRequest) GetType added in v0.19.0

func (x *ConfigureTypeRequest) GetType() string

func (*ConfigureTypeRequest) ProtoMessage added in v0.19.0

func (*ConfigureTypeRequest) ProtoMessage()

func (*ConfigureTypeRequest) ProtoReflect added in v0.19.0

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

func (*ConfigureTypeRequest) Reset added in v0.19.0

func (x *ConfigureTypeRequest) Reset()

func (*ConfigureTypeRequest) String added in v0.19.0

func (x *ConfigureTypeRequest) String() string

type ConfigureTypeResponse added in v0.19.0

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

func (*ConfigureTypeResponse) Descriptor deprecated added in v0.19.0

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

Deprecated: Use ConfigureTypeResponse.ProtoReflect.Descriptor instead.

func (*ConfigureTypeResponse) ProtoMessage added in v0.19.0

func (*ConfigureTypeResponse) ProtoMessage()

func (*ConfigureTypeResponse) ProtoReflect added in v0.19.0

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

func (*ConfigureTypeResponse) Reset added in v0.19.0

func (x *ConfigureTypeResponse) Reset()

func (*ConfigureTypeResponse) String added in v0.19.0

func (x *ConfigureTypeResponse) 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 CreateUploadRequest added in v0.17.18

type CreateUploadRequest struct {

	// Name of the uploaded file, this should be the basename of the file.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// ContentType is the type of the file as a mimetype.
	ContentType string `protobuf:"bytes,2,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// Meta can be used to set arbitrary key-value data on an upload.
	Meta map[string]string `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateUploadRequest) Descriptor deprecated added in v0.17.18

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

Deprecated: Use CreateUploadRequest.ProtoReflect.Descriptor instead.

func (*CreateUploadRequest) GetContentType added in v0.17.18

func (x *CreateUploadRequest) GetContentType() string

func (*CreateUploadRequest) GetMeta added in v0.17.18

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

func (*CreateUploadRequest) GetName added in v0.17.18

func (x *CreateUploadRequest) GetName() string

func (*CreateUploadRequest) ProtoMessage added in v0.17.18

func (*CreateUploadRequest) ProtoMessage()

func (*CreateUploadRequest) ProtoReflect added in v0.17.18

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

func (*CreateUploadRequest) Reset added in v0.17.18

func (x *CreateUploadRequest) Reset()

func (*CreateUploadRequest) String added in v0.17.18

func (x *CreateUploadRequest) String() string

type CreateUploadResponse added in v0.17.18

type CreateUploadResponse struct {

	// ID of the created upload.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL to PUT the object content to.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateUploadResponse) Descriptor deprecated added in v0.17.18

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

Deprecated: Use CreateUploadResponse.ProtoReflect.Descriptor instead.

func (*CreateUploadResponse) GetId added in v0.17.18

func (x *CreateUploadResponse) GetId() string

func (*CreateUploadResponse) GetUrl added in v0.17.18

func (x *CreateUploadResponse) GetUrl() string

func (*CreateUploadResponse) ProtoMessage added in v0.17.18

func (*CreateUploadResponse) ProtoMessage()

func (*CreateUploadResponse) ProtoReflect added in v0.17.18

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

func (*CreateUploadResponse) Reset added in v0.17.18

func (x *CreateUploadResponse) Reset()

func (*CreateUploadResponse) String added in v0.17.18

func (x *CreateUploadResponse) 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 `` /* 135-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 `` /* 135-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 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 DeleteWorkflowRequest added in v0.17.7

type DeleteWorkflowRequest struct {

	// Type of the document to remove the workflow for.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteWorkflowRequest) Descriptor deprecated added in v0.17.7

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

Deprecated: Use DeleteWorkflowRequest.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowRequest) GetType added in v0.17.7

func (x *DeleteWorkflowRequest) GetType() string

func (*DeleteWorkflowRequest) ProtoMessage added in v0.17.7

func (*DeleteWorkflowRequest) ProtoMessage()

func (*DeleteWorkflowRequest) ProtoReflect added in v0.17.7

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

func (*DeleteWorkflowRequest) Reset added in v0.17.7

func (x *DeleteWorkflowRequest) Reset()

func (*DeleteWorkflowRequest) String added in v0.17.7

func (x *DeleteWorkflowRequest) String() string

type DeleteWorkflowResponse added in v0.17.7

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

func (*DeleteWorkflowResponse) Descriptor deprecated added in v0.17.7

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

Deprecated: Use DeleteWorkflowResponse.ProtoReflect.Descriptor instead.

func (*DeleteWorkflowResponse) ProtoMessage added in v0.17.7

func (*DeleteWorkflowResponse) ProtoMessage()

func (*DeleteWorkflowResponse) ProtoReflect added in v0.17.7

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

func (*DeleteWorkflowResponse) Reset added in v0.17.7

func (x *DeleteWorkflowResponse) Reset()

func (*DeleteWorkflowResponse) String added in v0.17.7

func (x *DeleteWorkflowResponse) 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 DocumentFilter added in v0.19.0

type DocumentFilter struct {

	// Expression used to extract values from the document.
	Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
	// Operator to use when comparing the provided values to the extracted values.
	Operator FilterOperator `protobuf:"varint,2,opt,name=operator,proto3,enum=elephant.repository.FilterOperator" json:"operator,omitempty"`
	// Values to compare to the extracted values.
	Values []*FilterValues `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
	// And filters that all must be true.
	And []*DocumentFilter `protobuf:"bytes,4,rep,name=and,proto3" json:"and,omitempty"`
	// Or filters of which at least one must be true.
	Or []*DocumentFilter `protobuf:"bytes,5,rep,name=or,proto3" json:"or,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentFilter) Descriptor deprecated added in v0.19.0

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

Deprecated: Use DocumentFilter.ProtoReflect.Descriptor instead.

func (*DocumentFilter) GetAnd added in v0.19.0

func (x *DocumentFilter) GetAnd() []*DocumentFilter

func (*DocumentFilter) GetExpression added in v0.19.0

func (x *DocumentFilter) GetExpression() string

func (*DocumentFilter) GetOperator added in v0.19.0

func (x *DocumentFilter) GetOperator() FilterOperator

func (*DocumentFilter) GetOr added in v0.19.0

func (x *DocumentFilter) GetOr() []*DocumentFilter

func (*DocumentFilter) GetValues added in v0.19.0

func (x *DocumentFilter) GetValues() []*FilterValues

func (*DocumentFilter) ProtoMessage added in v0.19.0

func (*DocumentFilter) ProtoMessage()

func (*DocumentFilter) ProtoReflect added in v0.19.0

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

func (*DocumentFilter) Reset added in v0.19.0

func (x *DocumentFilter) Reset()

func (*DocumentFilter) String added in v0.19.0

func (x *DocumentFilter) String() string

type DocumentMatch added in v0.19.0

type DocumentMatch struct {

	// UUID of the document.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Version of the document.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Document for the match.
	Document *newsdoc.Document `protobuf:"bytes,3,opt,name=document,proto3" json:"document,omitempty"`
	// Meta information for the match.
	Meta *DocumentMeta `protobuf:"bytes,4,opt,name=meta,proto3" json:"meta,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentMatch) Descriptor deprecated added in v0.19.0

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

Deprecated: Use DocumentMatch.ProtoReflect.Descriptor instead.

func (*DocumentMatch) GetDocument added in v0.19.0

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

func (*DocumentMatch) GetMeta added in v0.19.0

func (x *DocumentMatch) GetMeta() *DocumentMeta

func (*DocumentMatch) GetUuid added in v0.19.0

func (x *DocumentMatch) GetUuid() string

func (*DocumentMatch) GetVersion added in v0.19.0

func (x *DocumentMatch) GetVersion() int64

func (*DocumentMatch) ProtoMessage added in v0.19.0

func (*DocumentMatch) ProtoMessage()

func (*DocumentMatch) ProtoReflect added in v0.19.0

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

func (*DocumentMatch) Reset added in v0.19.0

func (x *DocumentMatch) Reset()

func (*DocumentMatch) String added in v0.19.0

func (x *DocumentMatch) 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 `` /* 137-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"`
	// WorkflowState that the document is in.
	WorkflowState string `protobuf:"bytes,9,opt,name=workflow_state,json=workflowState,proto3" json:"workflow_state,omitempty"`
	// WorkflowCheckpoint that the document reached most recently.
	WorkflowCheckpoint string `protobuf:"bytes,10,opt,name=workflow_checkpoint,json=workflowCheckpoint,proto3" json:"workflow_checkpoint,omitempty"`
	// CreatorURI is the identity of the party that created the document.
	CreatorUri string `protobuf:"bytes,11,opt,name=creator_uri,json=creatorUri,proto3" json:"creator_uri,omitempty"`
	// UpdaterURI is the identity of the party that last updated the document.
	UpdaterUri string `protobuf:"bytes,12,opt,name=updater_uri,json=updaterUri,proto3" json:"updater_uri,omitempty"`
	// Attachments are the names of the attached objects (files) for a document.
	Attachments []*AttachmentRef `protobuf:"bytes,13,rep,name=attachments,proto3" json:"attachments,omitempty"`
	// Nonce is the unique nonce for this document. If the document is deleted and
	// recreated with the same ID it will still have a unique nonce.
	Nonce string `protobuf:"bytes,14,opt,name=nonce,proto3" json:"nonce,omitempty"`
	// Type is the type of the document.
	Type string `protobuf:"bytes,15,opt,name=type,proto3" json:"type,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) GetAttachments added in v0.17.18

func (x *DocumentMeta) GetAttachments() []*AttachmentRef

func (*DocumentMeta) GetCreated

func (x *DocumentMeta) GetCreated() string

func (*DocumentMeta) GetCreatorUri added in v0.17.14

func (x *DocumentMeta) GetCreatorUri() 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) GetNonce added in v0.18.1

func (x *DocumentMeta) GetNonce() string

func (*DocumentMeta) GetType added in v0.19.0

func (x *DocumentMeta) GetType() string

func (*DocumentMeta) GetUpdaterUri added in v0.17.14

func (x *DocumentMeta) GetUpdaterUri() string

func (*DocumentMeta) GetWorkflowCheckpoint added in v0.17.7

func (x *DocumentMeta) GetWorkflowCheckpoint() string

func (*DocumentMeta) GetWorkflowState added in v0.17.7

func (x *DocumentMeta) GetWorkflowState() 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 DocumentMetrics added in v0.17.16

type DocumentMetrics struct {
	Uuid    string    `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	Metrics []*Metric `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentMetrics) Descriptor deprecated added in v0.17.16

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

Deprecated: Use DocumentMetrics.ProtoReflect.Descriptor instead.

func (*DocumentMetrics) GetMetrics added in v0.17.16

func (x *DocumentMetrics) GetMetrics() []*Metric

func (*DocumentMetrics) GetUuid added in v0.17.16

func (x *DocumentMetrics) GetUuid() string

func (*DocumentMetrics) ProtoMessage added in v0.17.16

func (*DocumentMetrics) ProtoMessage()

func (*DocumentMetrics) ProtoReflect added in v0.17.16

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

func (*DocumentMetrics) Reset added in v0.17.16

func (x *DocumentMetrics) Reset()

func (*DocumentMetrics) String added in v0.17.16

func (x *DocumentMetrics) String() string

type DocumentStatuses added in v0.17.15

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

func (*DocumentStatuses) Descriptor deprecated added in v0.17.15

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

Deprecated: Use DocumentStatuses.ProtoReflect.Descriptor instead.

func (*DocumentStatuses) GetItems added in v0.17.15

func (x *DocumentStatuses) GetItems() []*Status

func (*DocumentStatuses) ProtoMessage added in v0.17.15

func (*DocumentStatuses) ProtoMessage()

func (*DocumentStatuses) ProtoReflect added in v0.17.15

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

func (*DocumentStatuses) Reset added in v0.17.15

func (x *DocumentStatuses) Reset()

func (*DocumentStatuses) String added in v0.17.15

func (x *DocumentStatuses) 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 `` /* 135-byte string literal not displayed */
	// Statuses that have been set for the document version.
	Statuses map[string]*DocumentStatuses `` /* 143-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) GetStatuses added in v0.17.15

func (x *DocumentVersion) GetStatuses() map[string]*DocumentStatuses

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 DocumentWorkflow added in v0.17.7

type DocumentWorkflow struct {

	// StepZero is the step that the state begins in, or reverts to after a
	// checkpoint.
	StepZero string `protobuf:"bytes,1,opt,name=step_zero,json=stepZero,proto3" json:"step_zero,omitempty"`
	// Checkpoint is the status that should be used as the state checkpoint.
	Checkpoint string `protobuf:"bytes,2,opt,name=checkpoint,proto3" json:"checkpoint,omitempty"`
	// NegativeCheckpoint is the state that should be used when the checkpoint
	// status is set using a negative version.
	NegativeCheckpoint string `protobuf:"bytes,3,opt,name=negative_checkpoint,json=negativeCheckpoint,proto3" json:"negative_checkpoint,omitempty"`
	// Steps are the names of statuses that should be used as steps between
	// checkpoints.
	Steps []string `protobuf:"bytes,4,rep,name=steps,proto3" json:"steps,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentWorkflow) Descriptor deprecated added in v0.17.7

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

Deprecated: Use DocumentWorkflow.ProtoReflect.Descriptor instead.

func (*DocumentWorkflow) GetCheckpoint added in v0.17.7

func (x *DocumentWorkflow) GetCheckpoint() string

func (*DocumentWorkflow) GetNegativeCheckpoint added in v0.17.7

func (x *DocumentWorkflow) GetNegativeCheckpoint() string

func (*DocumentWorkflow) GetStepZero added in v0.17.7

func (x *DocumentWorkflow) GetStepZero() string

func (*DocumentWorkflow) GetSteps added in v0.17.7

func (x *DocumentWorkflow) GetSteps() []string

func (*DocumentWorkflow) ProtoMessage added in v0.17.7

func (*DocumentWorkflow) ProtoMessage()

func (*DocumentWorkflow) ProtoReflect added in v0.17.7

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

func (*DocumentWorkflow) Reset added in v0.17.7

func (x *DocumentWorkflow) Reset()

func (*DocumentWorkflow) String added in v0.17.7

func (x *DocumentWorkflow) 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)

	// Prune will attempt to remove invalid parts of a document until what remains
	// is valid. If that's not possible it will return the same kind of error
	// information as a Validate call would return, highlighting the remaining
	// issues.
	Prune(context.Context, *PruneRequest) (*PruneResponse, error)

	// Evict removes stored document versions from the main database. The evicted
	// data will be restored from the archive if requested again by clients. It's
	// not allowed to evict the current version of a document.
	Evict(context.Context, *EvictRequest) (*EvictResponse, 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 for a document.
	GetStatus(context.Context, *GetStatusRequest) (*GetStatusResponse, error)

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

	// GetNilStatuses returns all the statuses for a document where version is -1.
	GetNilStatuses(context.Context, *GetNilStatusesRequest) (*GetNilStatusesResponse, 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)

	// GetWithheld returns the next upcoming scheduled publish actions. This is
	// not a complete list, but a list of the next N documents that are considered
	// eligible for publishing.
	GetWithheld(context.Context, *GetWithheldRequest) (*GetWithheldResponse, error)

	// GetDeliverableInfo returns available information related to the deliverable.
	GetDeliverableInfo(context.Context, *GetDeliverableInfoRequest) (*GetDeliverableInfoResponse, error)

	// CreateUpload is used to start the process of uploading objects that then
	// can be attached to a document.
	CreateUpload(context.Context, *CreateUploadRequest) (*CreateUploadResponse, error)

	// GetAttachments returns download links for the requested attachments.
	GetAttachments(context.Context, *GetAttachmentsRequest) (*GetAttachmentsResponse, error)

	// GetMatching returns documents matching the given criteria.
	GetMatching(context.Context, *GetMatchingRequest) (*GetMatchingResponse, error)

	// GetSocketToken returns a token that can be used to open socket connections.
	GetSocketToken(context.Context, *GetSocketTokenRequest) (*GetSocketTokenResponse, 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", "workflow".
	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"`
	// WorkflowState that the document is in.
	WorkflowState string `protobuf:"bytes,15,opt,name=workflow_state,json=workflowState,proto3" json:"workflow_state,omitempty"`
	// WorkflowCheckpoint that the document reached most recently.
	WorkflowCheckpoint string `protobuf:"bytes,16,opt,name=workflow_checkpoint,json=workflowCheckpoint,proto3" json:"workflow_checkpoint,omitempty"`
	// MainDocumentType is the type of the main document if the document is a
	// metadata document.
	MainDocumentType string `protobuf:"bytes,17,opt,name=main_document_type,json=mainDocumentType,proto3" json:"main_document_type,omitempty"`
	// AttachedObjects contains the object names, f.ex. "image" or "audio", when
	// when objects (files) were attached together with a document update.
	AttachedObjects []string `protobuf:"bytes,18,rep,name=attached_objects,json=attachedObjects,proto3" json:"attached_objects,omitempty"`
	// DetachedObjects contains the object names, f.ex. "image" or "audio", when
	// when objects (files) were detached in a document update.
	DetachedObjects []string `protobuf:"bytes,19,rep,name=detached_objects,json=detachedObjects,proto3" json:"detached_objects,omitempty"`
	// DeleteRecordId is the ID of the delete record if this was a delete event.
	DeleteRecordId int64 `protobuf:"varint,20,opt,name=delete_record_id,json=deleteRecordId,proto3" json:"delete_record_id,omitempty"`
	// DocumentNonce is the unique nonce for this document. If the document is
	// deleted and recreated with the same ID it will still have a unique nonce.
	DocumentNonce string `protobuf:"bytes,21,opt,name=document_nonce,json=documentNonce,proto3" json:"document_nonce,omitempty"`
	// Timespans are the timespans that were extracted from the last document
	// update and from the assignment if this document is a deliverable.
	Timespans []*Timespan `protobuf:"bytes,22,rep,name=timespans,proto3" json:"timespans,omitempty"`
	// Labels are the labels that were extracted from the last document update.
	Labels []string `protobuf:"bytes,23,rep,name=labels,proto3" json:"labels,omitempty"`
	// SchemaGeneration is the ID of the schema generation that was used to
	// validate the document.
	SchemaGeneration int64 `protobuf:"varint,24,opt,name=schema_generation,json=schemaGeneration,proto3" json:"schema_generation,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) GetAttachedObjects added in v0.17.18

func (x *EventlogItem) GetAttachedObjects() []string

func (*EventlogItem) GetDeleteRecordId added in v0.17.18

func (x *EventlogItem) GetDeleteRecordId() int64

func (*EventlogItem) GetDetachedObjects added in v0.17.18

func (x *EventlogItem) GetDetachedObjects() []string

func (*EventlogItem) GetDocumentNonce added in v0.18.1

func (x *EventlogItem) GetDocumentNonce() string

func (*EventlogItem) GetEvent

func (x *EventlogItem) GetEvent() string

func (*EventlogItem) GetId

func (x *EventlogItem) GetId() int64

func (*EventlogItem) GetLabels added in v0.19.0

func (x *EventlogItem) GetLabels() []string

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) GetMainDocumentType added in v0.17.8

func (x *EventlogItem) GetMainDocumentType() string

func (*EventlogItem) GetOldLanguage added in v0.10.0

func (x *EventlogItem) GetOldLanguage() string

func (*EventlogItem) GetSchemaGeneration added in v0.22.0

func (x *EventlogItem) GetSchemaGeneration() int64

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) GetTimespans added in v0.19.0

func (x *EventlogItem) GetTimespans() []*Timespan

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) GetWorkflowCheckpoint added in v0.17.7

func (x *EventlogItem) GetWorkflowCheckpoint() string

func (*EventlogItem) GetWorkflowState added in v0.17.7

func (x *EventlogItem) GetWorkflowState() string

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 EvictRequest added in v0.21.3

type EvictRequest struct {

	// UUID of the document to evict versions of.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Version can be set to a specific version to evict, optional.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// UntilVersion can be set to evict all versions up to (inclusive) the
	// specified version, optional. A negative value will be interpreted as
	// relative to the current version, set to -1 to evict all non-current
	// versions.
	UntilVersion int64 `protobuf:"varint,3,opt,name=until_version,json=untilVersion,proto3" json:"until_version,omitempty"`
	// contains filtered or unexported fields
}

func (*EvictRequest) Descriptor deprecated added in v0.21.3

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

Deprecated: Use EvictRequest.ProtoReflect.Descriptor instead.

func (*EvictRequest) GetUntilVersion added in v0.21.3

func (x *EvictRequest) GetUntilVersion() int64

func (*EvictRequest) GetUuid added in v0.21.3

func (x *EvictRequest) GetUuid() string

func (*EvictRequest) GetVersion added in v0.21.3

func (x *EvictRequest) GetVersion() int64

func (*EvictRequest) ProtoMessage added in v0.21.3

func (*EvictRequest) ProtoMessage()

func (*EvictRequest) ProtoReflect added in v0.21.3

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

func (*EvictRequest) Reset added in v0.21.3

func (x *EvictRequest) Reset()

func (*EvictRequest) String added in v0.21.3

func (x *EvictRequest) String() string

type EvictResponse added in v0.21.3

type EvictResponse struct {

	// EvictCount is the number of versions that were evicted.
	EvictCount int64 `protobuf:"varint,1,opt,name=evict_count,json=evictCount,proto3" json:"evict_count,omitempty"`
	// contains filtered or unexported fields
}

func (*EvictResponse) Descriptor deprecated added in v0.21.3

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

Deprecated: Use EvictResponse.ProtoReflect.Descriptor instead.

func (*EvictResponse) GetEvictCount added in v0.21.3

func (x *EvictResponse) GetEvictCount() int64

func (*EvictResponse) ProtoMessage added in v0.21.3

func (*EvictResponse) ProtoMessage()

func (*EvictResponse) ProtoReflect added in v0.21.3

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

func (*EvictResponse) Reset added in v0.21.3

func (x *EvictResponse) Reset()

func (*EvictResponse) String added in v0.21.3

func (x *EvictResponse) String() string

type Exemplar added in v0.22.0

type Exemplar struct {

	// Name of the exemplar.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Document is the exemplar newsdoc document.
	Document *newsdoc.Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// VersionHash is the version hash of the exemplar document.
	VersionHash string `protobuf:"bytes,3,opt,name=version_hash,json=versionHash,proto3" json:"version_hash,omitempty"`
	// contains filtered or unexported fields
}

func (*Exemplar) Descriptor deprecated added in v0.22.0

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

Deprecated: Use Exemplar.ProtoReflect.Descriptor instead.

func (*Exemplar) GetDocument added in v0.22.0

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

func (*Exemplar) GetName added in v0.22.0

func (x *Exemplar) GetName() string

func (*Exemplar) GetVersionHash added in v0.22.0

func (x *Exemplar) GetVersionHash() string

func (*Exemplar) ProtoMessage added in v0.22.0

func (*Exemplar) ProtoMessage()

func (*Exemplar) ProtoReflect added in v0.22.0

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

func (*Exemplar) Reset added in v0.22.0

func (x *Exemplar) Reset()

func (*Exemplar) String added in v0.22.0

func (x *Exemplar) 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 ExtractedValue added in v0.21.0

type ExtractedValue struct {

	// Value is used for extracted attributes and data values.
	Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// Block is used for block extractors.
	Block *newsdoc.Block `protobuf:"bytes,2,opt,name=block,proto3" json:"block,omitempty"`
	// Annotations can be used to differentiate between different extracted values.
	Annotation string `protobuf:"bytes,3,opt,name=annotation,proto3" json:"annotation,omitempty"`
	// Role can be used to differentiate between different extracted values.
	Role string `protobuf:"bytes,4,opt,name=role,proto3" json:"role,omitempty"`
	// contains filtered or unexported fields
}

func (*ExtractedValue) Descriptor deprecated added in v0.21.0

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

Deprecated: Use ExtractedValue.ProtoReflect.Descriptor instead.

func (*ExtractedValue) GetAnnotation added in v0.21.0

func (x *ExtractedValue) GetAnnotation() string

func (*ExtractedValue) GetBlock added in v0.21.0

func (x *ExtractedValue) GetBlock() *newsdoc.Block

func (*ExtractedValue) GetRole added in v0.21.0

func (x *ExtractedValue) GetRole() string

func (*ExtractedValue) GetValue added in v0.21.0

func (x *ExtractedValue) GetValue() string

func (*ExtractedValue) ProtoMessage added in v0.21.0

func (*ExtractedValue) ProtoMessage()

func (*ExtractedValue) ProtoReflect added in v0.21.0

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

func (*ExtractedValue) Reset added in v0.21.0

func (x *ExtractedValue) Reset()

func (*ExtractedValue) String added in v0.21.0

func (x *ExtractedValue) String() string

type ExtractedValues added in v0.21.0

type ExtractedValues struct {

	// Extractor index for the the extractor that produced the values.
	Extractor int64 `protobuf:"varint,1,opt,name=extractor,proto3" json:"extractor,omitempty"`
	// Values that were extracted.
	Values map[string]*ExtractedValue `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ExtractedValues) Descriptor deprecated added in v0.21.0

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

Deprecated: Use ExtractedValues.ProtoReflect.Descriptor instead.

func (*ExtractedValues) GetExtractor added in v0.21.0

func (x *ExtractedValues) GetExtractor() int64

func (*ExtractedValues) GetValues added in v0.21.0

func (x *ExtractedValues) GetValues() map[string]*ExtractedValue

func (*ExtractedValues) ProtoMessage added in v0.21.0

func (*ExtractedValues) ProtoMessage()

func (*ExtractedValues) ProtoReflect added in v0.21.0

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

func (*ExtractedValues) Reset added in v0.21.0

func (x *ExtractedValues) Reset()

func (*ExtractedValues) String added in v0.21.0

func (x *ExtractedValues) String() string

type FilterOperator added in v0.19.0

type FilterOperator int32
const (
	FilterOperator_FILTER_OP_UNKNOWN FilterOperator = 0
	FilterOperator_FILTER_OP_ANY     FilterOperator = 1
	FilterOperator_FILTER_OP_ALL     FilterOperator = 2
	FilterOperator_FILTER_OP_NONE    FilterOperator = 3
)

func (FilterOperator) Descriptor added in v0.19.0

func (FilterOperator) Enum added in v0.19.0

func (x FilterOperator) Enum() *FilterOperator

func (FilterOperator) EnumDescriptor deprecated added in v0.19.0

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

Deprecated: Use FilterOperator.Descriptor instead.

func (FilterOperator) Number added in v0.19.0

func (FilterOperator) String added in v0.19.0

func (x FilterOperator) String() string

func (FilterOperator) Type added in v0.19.0

type FilterValues added in v0.19.0

type FilterValues struct {
	Values map[string]string `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*FilterValues) Descriptor deprecated added in v0.19.0

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

Deprecated: Use FilterValues.ProtoReflect.Descriptor instead.

func (*FilterValues) GetValues added in v0.19.0

func (x *FilterValues) GetValues() map[string]string

func (*FilterValues) ProtoMessage added in v0.19.0

func (*FilterValues) ProtoMessage()

func (*FilterValues) ProtoReflect added in v0.19.0

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

func (*FilterValues) Reset added in v0.19.0

func (x *FilterValues) Reset()

func (*FilterValues) String added in v0.19.0

func (x *FilterValues) String() string

type GetAllActiveSchemasRequest

type GetAllActiveSchemasRequest struct {

	// WaitSeconds is the maximum number of seconds to wait for changes, defaults
	// to 10 seconds. Optional.
	WaitSeconds int64 `protobuf:"varint,1,opt,name=wait_seconds,json=waitSeconds,proto3" json:"wait_seconds,omitempty"`
	// Known schema versions that the client already has. Optional.
	Known map[string]string `` /* 137-byte string literal not displayed */
	// OnlyChanged only returns the schemas that have been changed.
	OnlyChanged bool `protobuf:"varint,3,opt,name=only_changed,json=onlyChanged,proto3" json:"only_changed,omitempty"`
	// 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) GetOnlyChanged added in v0.17.24

func (x *GetAllActiveSchemasRequest) GetOnlyChanged() bool

func (*GetAllActiveSchemasRequest) GetWaitSeconds

func (x *GetAllActiveSchemasRequest) GetWaitSeconds() int64

func (*GetAllActiveSchemasRequest) ProtoMessage

func (*GetAllActiveSchemasRequest) ProtoMessage()

func (*GetAllActiveSchemasRequest) ProtoReflect

func (*GetAllActiveSchemasRequest) Reset

func (x *GetAllActiveSchemasRequest) Reset()

func (*GetAllActiveSchemasRequest) String

func (x *GetAllActiveSchemasRequest) String() string

type GetAllActiveSchemasResponse

type GetAllActiveSchemasResponse struct {

	// Schemas that currently are active.
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// Unchanged is set to true if no changes were done compared to known schema
	// versions.
	Unchanged bool `protobuf:"varint,2,opt,name=unchanged,proto3" json:"unchanged,omitempty"`
	// Removed schemas.
	Removed []string `protobuf:"bytes,3,rep,name=removed,proto3" json:"removed,omitempty"`
	// GenerationID is the ID of the currently active schema generation.
	GenerationId int64 `protobuf:"varint,4,opt,name=generation_id,json=generationId,proto3" json:"generation_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAllActiveSchemasResponse) Descriptor deprecated

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

Deprecated: Use GetAllActiveSchemasResponse.ProtoReflect.Descriptor instead.

func (*GetAllActiveSchemasResponse) GetGenerationId added in v0.22.0

func (x *GetAllActiveSchemasResponse) GetGenerationId() int64

func (*GetAllActiveSchemasResponse) GetRemoved added in v0.17.24

func (x *GetAllActiveSchemasResponse) GetRemoved() []string

func (*GetAllActiveSchemasResponse) GetSchemas

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

func (*GetAllActiveSchemasResponse) GetUnchanged added in v0.17.24

func (x *GetAllActiveSchemasResponse) GetUnchanged() bool

func (*GetAllActiveSchemasResponse) ProtoMessage

func (*GetAllActiveSchemasResponse) ProtoMessage()

func (*GetAllActiveSchemasResponse) ProtoReflect

func (*GetAllActiveSchemasResponse) Reset

func (x *GetAllActiveSchemasResponse) Reset()

func (*GetAllActiveSchemasResponse) String

func (x *GetAllActiveSchemasResponse) String() string

type GetAttachmentsRequest added in v0.17.18

type GetAttachmentsRequest struct {

	// Documents to get attachments for.
	Documents []string `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// Attachment name to get information for.
	AttachmentName string `protobuf:"bytes,2,opt,name=attachment_name,json=attachmentName,proto3" json:"attachment_name,omitempty"`
	// DownloadLink should be set to true to generate a download link.
	DownloadLink bool `protobuf:"varint,3,opt,name=download_link,json=downloadLink,proto3" json:"download_link,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAttachmentsRequest) Descriptor deprecated added in v0.17.18

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

Deprecated: Use GetAttachmentsRequest.ProtoReflect.Descriptor instead.

func (*GetAttachmentsRequest) GetAttachmentName added in v0.17.18

func (x *GetAttachmentsRequest) GetAttachmentName() string

func (*GetAttachmentsRequest) GetDocuments added in v0.17.18

func (x *GetAttachmentsRequest) GetDocuments() []string
func (x *GetAttachmentsRequest) GetDownloadLink() bool

func (*GetAttachmentsRequest) ProtoMessage added in v0.17.18

func (*GetAttachmentsRequest) ProtoMessage()

func (*GetAttachmentsRequest) ProtoReflect added in v0.17.18

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

func (*GetAttachmentsRequest) Reset added in v0.17.18

func (x *GetAttachmentsRequest) Reset()

func (*GetAttachmentsRequest) String added in v0.17.18

func (x *GetAttachmentsRequest) String() string

type GetAttachmentsResponse added in v0.17.18

type GetAttachmentsResponse struct {
	Attachments []*AttachmentDetails `protobuf:"bytes,1,rep,name=attachments,proto3" json:"attachments,omitempty"`
	// contains filtered or unexported fields
}

func (*GetAttachmentsResponse) Descriptor deprecated added in v0.17.18

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

Deprecated: Use GetAttachmentsResponse.ProtoReflect.Descriptor instead.

func (*GetAttachmentsResponse) GetAttachments added in v0.17.18

func (x *GetAttachmentsResponse) GetAttachments() []*AttachmentDetails

func (*GetAttachmentsResponse) ProtoMessage added in v0.17.18

func (*GetAttachmentsResponse) ProtoMessage()

func (*GetAttachmentsResponse) ProtoReflect added in v0.17.18

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

func (*GetAttachmentsResponse) Reset added in v0.17.18

func (x *GetAttachmentsResponse) Reset()

func (*GetAttachmentsResponse) String added in v0.17.18

func (x *GetAttachmentsResponse) 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 (*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 (*GetCompactedEventlogResponse) Reset added in v0.7.0

func (x *GetCompactedEventlogResponse) Reset()

func (*GetCompactedEventlogResponse) String added in v0.7.0

type GetDeliverableInfoRequest added in v0.17.21

type GetDeliverableInfoRequest struct {

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

func (*GetDeliverableInfoRequest) Descriptor deprecated added in v0.17.21

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

Deprecated: Use GetDeliverableInfoRequest.ProtoReflect.Descriptor instead.

func (*GetDeliverableInfoRequest) GetUuid added in v0.17.21

func (x *GetDeliverableInfoRequest) GetUuid() string

func (*GetDeliverableInfoRequest) ProtoMessage added in v0.17.21

func (*GetDeliverableInfoRequest) ProtoMessage()

func (*GetDeliverableInfoRequest) ProtoReflect added in v0.17.21

func (*GetDeliverableInfoRequest) Reset added in v0.17.21

func (x *GetDeliverableInfoRequest) Reset()

func (*GetDeliverableInfoRequest) String added in v0.17.21

func (x *GetDeliverableInfoRequest) String() string

type GetDeliverableInfoResponse added in v0.17.21

type GetDeliverableInfoResponse struct {

	// Indicates whether the deliverable has planning information.
	HasPlanningInfo bool `protobuf:"varint,1,opt,name=has_planning_info,json=hasPlanningInfo,proto3" json:"has_planning_info,omitempty"`
	// UUID of the related planning item.
	PlanningUuid string `protobuf:"bytes,2,opt,name=planning_uuid,json=planningUuid,proto3" json:"planning_uuid,omitempty"`
	// UUID of the related assignment.
	AssignmentUuid string `protobuf:"bytes,3,opt,name=assignment_uuid,json=assignmentUuid,proto3" json:"assignment_uuid,omitempty"`
	// UUID of the related event.
	EventUuid string `protobuf:"bytes,4,opt,name=event_uuid,json=eventUuid,proto3" json:"event_uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDeliverableInfoResponse) Descriptor deprecated added in v0.17.21

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

Deprecated: Use GetDeliverableInfoResponse.ProtoReflect.Descriptor instead.

func (*GetDeliverableInfoResponse) GetAssignmentUuid added in v0.17.21

func (x *GetDeliverableInfoResponse) GetAssignmentUuid() string

func (*GetDeliverableInfoResponse) GetEventUuid added in v0.17.21

func (x *GetDeliverableInfoResponse) GetEventUuid() string

func (*GetDeliverableInfoResponse) GetHasPlanningInfo added in v0.17.21

func (x *GetDeliverableInfoResponse) GetHasPlanningInfo() bool

func (*GetDeliverableInfoResponse) GetPlanningUuid added in v0.17.21

func (x *GetDeliverableInfoResponse) GetPlanningUuid() string

func (*GetDeliverableInfoResponse) ProtoMessage added in v0.17.21

func (*GetDeliverableInfoResponse) ProtoMessage()

func (*GetDeliverableInfoResponse) ProtoReflect added in v0.17.21

func (*GetDeliverableInfoResponse) Reset added in v0.17.21

func (x *GetDeliverableInfoResponse) Reset()

func (*GetDeliverableInfoResponse) String added in v0.17.21

func (x *GetDeliverableInfoResponse) 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 */
	// MetaDocumentVersion is used to fetch a specific version of meta document.
	// Can not be used with status. If status is specified,
	// the version the meta document had at the time the status was set is returned.
	// If ommited and status is not used, the latest meta document version is returned.
	MetaDocumentVersion int64 `protobuf:"varint,6,opt,name=meta_document_version,json=metaDocumentVersion,proto3" json:"meta_document_version,omitempty"`
	// Subset returns a subset of the document as specified by a list of newsdoc
	// value extractors.
	Subset []string `protobuf:"bytes,7,rep,name=subset,proto3" json:"subset,omitempty"`
	// 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) GetMetaDocumentVersion added in v0.17.20

func (x *GetDocumentRequest) GetMetaDocumentVersion() int64

func (*GetDocumentRequest) GetStatus

func (x *GetDocumentRequest) GetStatus() string

func (*GetDocumentRequest) GetSubset added in v0.21.0

func (x *GetDocumentRequest) GetSubset() []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"`
	// Subset is the extracted subset of the document.
	Subset []*ExtractedValues `protobuf:"bytes,7,rep,name=subset,proto3" json:"subset,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) GetSubset added in v0.21.0

func (x *GetDocumentResponse) GetSubset() []*ExtractedValues

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 GetDocumentTypesRequest added in v0.17.24

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

func (*GetDocumentTypesRequest) Descriptor deprecated added in v0.17.24

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

Deprecated: Use GetDocumentTypesRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentTypesRequest) ProtoMessage added in v0.17.24

func (*GetDocumentTypesRequest) ProtoMessage()

func (*GetDocumentTypesRequest) ProtoReflect added in v0.17.24

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

func (*GetDocumentTypesRequest) Reset added in v0.17.24

func (x *GetDocumentTypesRequest) Reset()

func (*GetDocumentTypesRequest) String added in v0.17.24

func (x *GetDocumentTypesRequest) String() string

type GetDocumentTypesResponse added in v0.17.24

type GetDocumentTypesResponse struct {

	// Types that have been defined in the schema.
	Types []string `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
	// contains filtered or unexported fields
}

func (*GetDocumentTypesResponse) Descriptor deprecated added in v0.17.24

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

Deprecated: Use GetDocumentTypesResponse.ProtoReflect.Descriptor instead.

func (*GetDocumentTypesResponse) GetTypes added in v0.17.24

func (x *GetDocumentTypesResponse) GetTypes() []string

func (*GetDocumentTypesResponse) ProtoMessage added in v0.17.24

func (*GetDocumentTypesResponse) ProtoMessage()

func (*GetDocumentTypesResponse) ProtoReflect added in v0.17.24

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

func (*GetDocumentTypesResponse) Reset added in v0.17.24

func (x *GetDocumentTypesResponse) Reset()

func (*GetDocumentTypesResponse) String added in v0.17.24

func (x *GetDocumentTypesResponse) 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 GetExemplarsRequest added in v0.22.0

type GetExemplarsRequest struct {

	// GenerationID is the ID of the schema generation to get exemplars for.
	GenerationId int64 `protobuf:"varint,1,opt,name=generation_id,json=generationId,proto3" json:"generation_id,omitempty"`
	// Known exemplar version hashes that the client already has, keyed by
	// exemplar name. Exemplars with matching version hashes will not be included
	// in the response.
	Known map[string]string `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetExemplarsRequest) Descriptor deprecated added in v0.22.0

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

Deprecated: Use GetExemplarsRequest.ProtoReflect.Descriptor instead.

func (*GetExemplarsRequest) GetGenerationId added in v0.22.0

func (x *GetExemplarsRequest) GetGenerationId() int64

func (*GetExemplarsRequest) GetKnown added in v0.22.0

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

func (*GetExemplarsRequest) ProtoMessage added in v0.22.0

func (*GetExemplarsRequest) ProtoMessage()

func (*GetExemplarsRequest) ProtoReflect added in v0.22.0

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

func (*GetExemplarsRequest) Reset added in v0.22.0

func (x *GetExemplarsRequest) Reset()

func (*GetExemplarsRequest) String added in v0.22.0

func (x *GetExemplarsRequest) String() string

type GetExemplarsResponse added in v0.22.0

type GetExemplarsResponse struct {

	// Exemplars are the exemplar documents for the schema generation.
	Exemplars []*Exemplar `protobuf:"bytes,1,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

func (*GetExemplarsResponse) Descriptor deprecated added in v0.22.0

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

Deprecated: Use GetExemplarsResponse.ProtoReflect.Descriptor instead.

func (*GetExemplarsResponse) GetExemplars added in v0.22.0

func (x *GetExemplarsResponse) GetExemplars() []*Exemplar

func (*GetExemplarsResponse) ProtoMessage added in v0.22.0

func (*GetExemplarsResponse) ProtoMessage()

func (*GetExemplarsResponse) ProtoReflect added in v0.22.0

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

func (*GetExemplarsResponse) Reset added in v0.22.0

func (x *GetExemplarsResponse) Reset()

func (*GetExemplarsResponse) String added in v0.22.0

func (x *GetExemplarsResponse) 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"`
	// LoadStatuses loads any statuses set on the document versions.
	LoadStatuses bool `protobuf:"varint,3,opt,name=load_statuses,json=loadStatuses,proto3" json:"load_statuses,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) GetLoadStatuses added in v0.17.15

func (x *GetHistoryRequest) GetLoadStatuses() bool

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 GetMatchingRequest added in v0.19.0

type GetMatchingRequest struct {

	// Type of the documents to get.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Timespan is the inclusive time range to get documents for. Optional, this
	// is only available for document types with time expressions and/or
	// deliverables.
	Timespan *Timespan `protobuf:"bytes,2,opt,name=timespan,proto3" json:"timespan,omitempty"`
	// Labels is a list of labels that the document must have to be included.
	Labels []string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty"`
	// Filter to apply to the documents.
	Filter *DocumentFilter `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// IncludeDocuments should be set to true to get the document for each match.
	IncludeDocuments bool `protobuf:"varint,5,opt,name=include_documents,json=includeDocuments,proto3" json:"include_documents,omitempty"`
	// IncludeMeta should be set to true to include document meta.
	IncludeMeta bool `protobuf:"varint,6,opt,name=include_meta,json=includeMeta,proto3" json:"include_meta,omitempty"`
	// Include will include documents with an UUID that matches the uuid of the
	// newdoc extraction expression. Timespans, labels and filters will not be
	// applied to included documents.
	Include []string `protobuf:"bytes,7,rep,name=include,proto3" json:"include,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMatchingRequest) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetMatchingRequest.ProtoReflect.Descriptor instead.

func (*GetMatchingRequest) GetFilter added in v0.19.0

func (x *GetMatchingRequest) GetFilter() *DocumentFilter

func (*GetMatchingRequest) GetInclude added in v0.19.0

func (x *GetMatchingRequest) GetInclude() []string

func (*GetMatchingRequest) GetIncludeDocuments added in v0.19.0

func (x *GetMatchingRequest) GetIncludeDocuments() bool

func (*GetMatchingRequest) GetIncludeMeta added in v0.19.0

func (x *GetMatchingRequest) GetIncludeMeta() bool

func (*GetMatchingRequest) GetLabels added in v0.19.0

func (x *GetMatchingRequest) GetLabels() []string

func (*GetMatchingRequest) GetTimespan added in v0.19.0

func (x *GetMatchingRequest) GetTimespan() *Timespan

func (*GetMatchingRequest) GetType added in v0.19.0

func (x *GetMatchingRequest) GetType() string

func (*GetMatchingRequest) ProtoMessage added in v0.19.0

func (*GetMatchingRequest) ProtoMessage()

func (*GetMatchingRequest) ProtoReflect added in v0.19.0

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

func (*GetMatchingRequest) Reset added in v0.19.0

func (x *GetMatchingRequest) Reset()

func (*GetMatchingRequest) String added in v0.19.0

func (x *GetMatchingRequest) String() string

type GetMatchingResponse added in v0.19.0

type GetMatchingResponse struct {
	Matches []*DocumentMatch `protobuf:"bytes,1,rep,name=matches,proto3" json:"matches,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMatchingResponse) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetMatchingResponse.ProtoReflect.Descriptor instead.

func (*GetMatchingResponse) GetMatches added in v0.19.0

func (x *GetMatchingResponse) GetMatches() []*DocumentMatch

func (*GetMatchingResponse) ProtoMessage added in v0.19.0

func (*GetMatchingResponse) ProtoMessage()

func (*GetMatchingResponse) ProtoReflect added in v0.19.0

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

func (*GetMatchingResponse) Reset added in v0.19.0

func (x *GetMatchingResponse) Reset()

func (*GetMatchingResponse) String added in v0.19.0

func (x *GetMatchingResponse) 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

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 GetMetaTypesRequest added in v0.17.24

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

func (*GetMetaTypesRequest) Descriptor deprecated added in v0.17.24

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

Deprecated: Use GetMetaTypesRequest.ProtoReflect.Descriptor instead.

func (*GetMetaTypesRequest) ProtoMessage added in v0.17.24

func (*GetMetaTypesRequest) ProtoMessage()

func (*GetMetaTypesRequest) ProtoReflect added in v0.17.24

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

func (*GetMetaTypesRequest) Reset added in v0.17.24

func (x *GetMetaTypesRequest) Reset()

func (*GetMetaTypesRequest) String added in v0.17.24

func (x *GetMetaTypesRequest) String() string

type GetMetaTypesResponse added in v0.17.24

type GetMetaTypesResponse struct {
	Types []*MetaTypeInfo `protobuf:"bytes,1,rep,name=types,proto3" json:"types,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetaTypesResponse) Descriptor deprecated added in v0.17.24

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

Deprecated: Use GetMetaTypesResponse.ProtoReflect.Descriptor instead.

func (*GetMetaTypesResponse) GetTypes added in v0.17.24

func (x *GetMetaTypesResponse) GetTypes() []*MetaTypeInfo

func (*GetMetaTypesResponse) ProtoMessage added in v0.17.24

func (*GetMetaTypesResponse) ProtoMessage()

func (*GetMetaTypesResponse) ProtoReflect added in v0.17.24

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

func (*GetMetaTypesResponse) Reset added in v0.17.24

func (x *GetMetaTypesResponse) Reset()

func (*GetMetaTypesResponse) String added in v0.17.24

func (x *GetMetaTypesResponse) 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 GetMetricsRequest added in v0.17.5

type GetMetricsRequest struct {

	// The documents to get metrics for.
	Uuids []string `protobuf:"bytes,1,rep,name=uuids,proto3" json:"uuids,omitempty"`
	// The metric kinds to get. Optional, defaults to all.
	Kinds []string `protobuf:"bytes,2,rep,name=kinds,proto3" json:"kinds,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMetricsRequest) Descriptor deprecated added in v0.17.5

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

Deprecated: Use GetMetricsRequest.ProtoReflect.Descriptor instead.

func (*GetMetricsRequest) GetKinds added in v0.17.16

func (x *GetMetricsRequest) GetKinds() []string

func (*GetMetricsRequest) GetUuids added in v0.17.16

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

func (*GetMetricsRequest) ProtoMessage added in v0.17.5

func (*GetMetricsRequest) ProtoMessage()

func (*GetMetricsRequest) ProtoReflect added in v0.17.5

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

func (*GetMetricsRequest) Reset added in v0.17.5

func (x *GetMetricsRequest) Reset()

func (*GetMetricsRequest) String added in v0.17.5

func (x *GetMetricsRequest) String() string

type GetMetricsResponse added in v0.17.5

type GetMetricsResponse struct {
	Documents map[string]*DocumentMetrics `` /* 145-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetMetricsResponse) Descriptor deprecated added in v0.17.5

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

Deprecated: Use GetMetricsResponse.ProtoReflect.Descriptor instead.

func (*GetMetricsResponse) GetDocuments added in v0.17.16

func (x *GetMetricsResponse) GetDocuments() map[string]*DocumentMetrics

func (*GetMetricsResponse) ProtoMessage added in v0.17.5

func (*GetMetricsResponse) ProtoMessage()

func (*GetMetricsResponse) ProtoReflect added in v0.17.5

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

func (*GetMetricsResponse) Reset added in v0.17.5

func (x *GetMetricsResponse) Reset()

func (*GetMetricsResponse) String added in v0.17.5

func (x *GetMetricsResponse) String() string

type GetNilStatusesRequest added in v0.17.15

type GetNilStatusesRequest struct {

	// UUID of the document to get the nil statuses for.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Names of statuses to get, optional. Defaults to all statuses.
	Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"`
	// contains filtered or unexported fields
}

func (*GetNilStatusesRequest) Descriptor deprecated added in v0.17.15

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

Deprecated: Use GetNilStatusesRequest.ProtoReflect.Descriptor instead.

func (*GetNilStatusesRequest) GetNames added in v0.17.15

func (x *GetNilStatusesRequest) GetNames() []string

func (*GetNilStatusesRequest) GetUuid added in v0.17.15

func (x *GetNilStatusesRequest) GetUuid() string

func (*GetNilStatusesRequest) ProtoMessage added in v0.17.15

func (*GetNilStatusesRequest) ProtoMessage()

func (*GetNilStatusesRequest) ProtoReflect added in v0.17.15

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

func (*GetNilStatusesRequest) Reset added in v0.17.15

func (x *GetNilStatusesRequest) Reset()

func (*GetNilStatusesRequest) String added in v0.17.15

func (x *GetNilStatusesRequest) String() string

type GetNilStatusesResponse added in v0.17.15

type GetNilStatusesResponse struct {
	Statuses map[string]*DocumentStatuses `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetNilStatusesResponse) Descriptor deprecated added in v0.17.15

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

Deprecated: Use GetNilStatusesResponse.ProtoReflect.Descriptor instead.

func (*GetNilStatusesResponse) GetStatuses added in v0.17.15

func (x *GetNilStatusesResponse) GetStatuses() map[string]*DocumentStatuses

func (*GetNilStatusesResponse) ProtoMessage added in v0.17.15

func (*GetNilStatusesResponse) ProtoMessage()

func (*GetNilStatusesResponse) ProtoReflect added in v0.17.15

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

func (*GetNilStatusesResponse) Reset added in v0.17.15

func (x *GetNilStatusesResponse) Reset()

func (*GetNilStatusesResponse) String added in v0.17.15

func (x *GetNilStatusesResponse) 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 `` /* 149-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 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 GetSocketTokenRequest added in v0.19.0

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

func (*GetSocketTokenRequest) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetSocketTokenRequest.ProtoReflect.Descriptor instead.

func (*GetSocketTokenRequest) ProtoMessage added in v0.19.0

func (*GetSocketTokenRequest) ProtoMessage()

func (*GetSocketTokenRequest) ProtoReflect added in v0.19.0

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

func (*GetSocketTokenRequest) Reset added in v0.19.0

func (x *GetSocketTokenRequest) Reset()

func (*GetSocketTokenRequest) String added in v0.19.0

func (x *GetSocketTokenRequest) String() string

type GetSocketTokenResponse added in v0.19.0

type GetSocketTokenResponse struct {

	// Token that is unique for the calling user that can be used to open
	// websocket API connections.
	Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
	// Expires is the expiry time of the token as a RFC3339 timestamp.
	Expires string `protobuf:"bytes,2,opt,name=expires,proto3" json:"expires,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSocketTokenResponse) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetSocketTokenResponse.ProtoReflect.Descriptor instead.

func (*GetSocketTokenResponse) GetExpires added in v0.19.0

func (x *GetSocketTokenResponse) GetExpires() string

func (*GetSocketTokenResponse) GetToken added in v0.19.0

func (x *GetSocketTokenResponse) GetToken() string

func (*GetSocketTokenResponse) ProtoMessage added in v0.19.0

func (*GetSocketTokenResponse) ProtoMessage()

func (*GetSocketTokenResponse) ProtoReflect added in v0.19.0

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

func (*GetSocketTokenResponse) Reset added in v0.19.0

func (x *GetSocketTokenResponse) Reset()

func (*GetSocketTokenResponse) String added in v0.19.0

func (x *GetSocketTokenResponse) 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. Optional, omit to only return workflow
	// state.
	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 (*GetStatusOverviewResponse) ProtoMessage added in v0.12.0

func (*GetStatusOverviewResponse) ProtoMessage()

func (*GetStatusOverviewResponse) ProtoReflect added in v0.12.0

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 {

	// Type of documents to get statuses from.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStatusesRequest) Descriptor deprecated

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

Deprecated: Use GetStatusesRequest.ProtoReflect.Descriptor instead.

func (*GetStatusesRequest) GetType added in v0.17.13

func (x *GetStatusesRequest) GetType() string

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 GetTypeConfigurationRequest added in v0.19.0

type GetTypeConfigurationRequest struct {

	// Type to get configuration for.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTypeConfigurationRequest) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetTypeConfigurationRequest.ProtoReflect.Descriptor instead.

func (*GetTypeConfigurationRequest) GetType added in v0.19.0

func (x *GetTypeConfigurationRequest) GetType() string

func (*GetTypeConfigurationRequest) ProtoMessage added in v0.19.0

func (*GetTypeConfigurationRequest) ProtoMessage()

func (*GetTypeConfigurationRequest) ProtoReflect added in v0.19.0

func (*GetTypeConfigurationRequest) Reset added in v0.19.0

func (x *GetTypeConfigurationRequest) Reset()

func (*GetTypeConfigurationRequest) String added in v0.19.0

func (x *GetTypeConfigurationRequest) String() string

type GetTypeConfigurationResponse added in v0.19.0

type GetTypeConfigurationResponse struct {

	// Configuration of the type.
	Configuration *TypeConfiguration `protobuf:"bytes,1,opt,name=configuration,proto3" json:"configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTypeConfigurationResponse) Descriptor deprecated added in v0.19.0

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

Deprecated: Use GetTypeConfigurationResponse.ProtoReflect.Descriptor instead.

func (*GetTypeConfigurationResponse) GetConfiguration added in v0.19.0

func (x *GetTypeConfigurationResponse) GetConfiguration() *TypeConfiguration

func (*GetTypeConfigurationResponse) ProtoMessage added in v0.19.0

func (*GetTypeConfigurationResponse) ProtoMessage()

func (*GetTypeConfigurationResponse) ProtoReflect added in v0.19.0

func (*GetTypeConfigurationResponse) Reset added in v0.19.0

func (x *GetTypeConfigurationResponse) Reset()

func (*GetTypeConfigurationResponse) String added in v0.19.0

type GetWithheldRequest added in v0.17.17

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

func (*GetWithheldRequest) Descriptor deprecated added in v0.17.17

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

Deprecated: Use GetWithheldRequest.ProtoReflect.Descriptor instead.

func (*GetWithheldRequest) ProtoMessage added in v0.17.17

func (*GetWithheldRequest) ProtoMessage()

func (*GetWithheldRequest) ProtoReflect added in v0.17.17

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

func (*GetWithheldRequest) Reset added in v0.17.17

func (x *GetWithheldRequest) Reset()

func (*GetWithheldRequest) String added in v0.17.17

func (x *GetWithheldRequest) String() string

type GetWithheldResponse added in v0.17.17

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

func (*GetWithheldResponse) Descriptor deprecated added in v0.17.17

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

Deprecated: Use GetWithheldResponse.ProtoReflect.Descriptor instead.

func (*GetWithheldResponse) GetItems added in v0.17.17

func (x *GetWithheldResponse) GetItems() []*ScheduledDocument

func (*GetWithheldResponse) ProtoMessage added in v0.17.17

func (*GetWithheldResponse) ProtoMessage()

func (*GetWithheldResponse) ProtoReflect added in v0.17.17

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

func (*GetWithheldResponse) Reset added in v0.17.17

func (x *GetWithheldResponse) Reset()

func (*GetWithheldResponse) String added in v0.17.17

func (x *GetWithheldResponse) String() string

type GetWorkflowRequest added in v0.17.7

type GetWorkflowRequest struct {

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

func (*GetWorkflowRequest) Descriptor deprecated added in v0.17.7

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

Deprecated: Use GetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*GetWorkflowRequest) GetType added in v0.17.7

func (x *GetWorkflowRequest) GetType() string

func (*GetWorkflowRequest) ProtoMessage added in v0.17.7

func (*GetWorkflowRequest) ProtoMessage()

func (*GetWorkflowRequest) ProtoReflect added in v0.17.7

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

func (*GetWorkflowRequest) Reset added in v0.17.7

func (x *GetWorkflowRequest) Reset()

func (*GetWorkflowRequest) String added in v0.17.7

func (x *GetWorkflowRequest) String() string

type GetWorkflowResponse added in v0.17.7

type GetWorkflowResponse struct {

	// Workflow declaration.
	Workflow *DocumentWorkflow `protobuf:"bytes,1,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// UpdaterURI identifies the user that last updated the workflow.
	UpdaterUri string `protobuf:"bytes,2,opt,name=updater_uri,json=updaterUri,proto3" json:"updater_uri,omitempty"`
	// Updated is the update time as a RFC3339 timestamp.
	Updated string `protobuf:"bytes,3,opt,name=updated,proto3" json:"updated,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWorkflowResponse) Descriptor deprecated added in v0.17.7

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

Deprecated: Use GetWorkflowResponse.ProtoReflect.Descriptor instead.

func (*GetWorkflowResponse) GetUpdated added in v0.17.7

func (x *GetWorkflowResponse) GetUpdated() string

func (*GetWorkflowResponse) GetUpdaterUri added in v0.17.7

func (x *GetWorkflowResponse) GetUpdaterUri() string

func (*GetWorkflowResponse) GetWorkflow added in v0.17.7

func (x *GetWorkflowResponse) GetWorkflow() *DocumentWorkflow

func (*GetWorkflowResponse) ProtoMessage added in v0.17.7

func (*GetWorkflowResponse) ProtoMessage()

func (*GetWorkflowResponse) ProtoReflect added in v0.17.7

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

func (*GetWorkflowResponse) Reset added in v0.17.7

func (x *GetWorkflowResponse) Reset()

func (*GetWorkflowResponse) String added in v0.17.7

func (x *GetWorkflowResponse) 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 LabelExpression added in v0.19.0

type LabelExpression struct {

	// Expression is a newsdoc value extraction expression.
	Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
	// Template is the template that turns the extracted values into a label.
	Template string `protobuf:"bytes,2,opt,name=template,proto3" json:"template,omitempty"`
	// contains filtered or unexported fields
}

func (*LabelExpression) Descriptor deprecated added in v0.19.0

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

Deprecated: Use LabelExpression.ProtoReflect.Descriptor instead.

func (*LabelExpression) GetExpression added in v0.19.0

func (x *LabelExpression) GetExpression() string

func (*LabelExpression) GetTemplate added in v0.19.0

func (x *LabelExpression) GetTemplate() string

func (*LabelExpression) ProtoMessage added in v0.19.0

func (*LabelExpression) ProtoMessage()

func (*LabelExpression) ProtoReflect added in v0.19.0

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

func (*LabelExpression) Reset added in v0.19.0

func (x *LabelExpression) Reset()

func (*LabelExpression) String added in v0.19.0

func (x *LabelExpression) String() string

type ListActiveSchemasRequest added in v0.17.24

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

func (*ListActiveSchemasRequest) Descriptor deprecated added in v0.17.24

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

Deprecated: Use ListActiveSchemasRequest.ProtoReflect.Descriptor instead.

func (*ListActiveSchemasRequest) ProtoMessage added in v0.17.24

func (*ListActiveSchemasRequest) ProtoMessage()

func (*ListActiveSchemasRequest) ProtoReflect added in v0.17.24

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

func (*ListActiveSchemasRequest) Reset added in v0.17.24

func (x *ListActiveSchemasRequest) Reset()

func (*ListActiveSchemasRequest) String added in v0.17.24

func (x *ListActiveSchemasRequest) String() string

type ListActiveSchemasResponse added in v0.17.24

type ListActiveSchemasResponse struct {

	// Schemas without the spec populated
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// GenerationID is the ID of the currently active schema generation.
	GenerationId int64 `protobuf:"varint,2,opt,name=generation_id,json=generationId,proto3" json:"generation_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ListActiveSchemasResponse) Descriptor deprecated added in v0.17.24

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

Deprecated: Use ListActiveSchemasResponse.ProtoReflect.Descriptor instead.

func (*ListActiveSchemasResponse) GetGenerationId added in v0.22.0

func (x *ListActiveSchemasResponse) GetGenerationId() int64

func (*ListActiveSchemasResponse) GetSchemas added in v0.17.24

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

func (*ListActiveSchemasResponse) ProtoMessage added in v0.17.24

func (*ListActiveSchemasResponse) ProtoMessage()

func (*ListActiveSchemasResponse) ProtoReflect added in v0.17.24

func (*ListActiveSchemasResponse) Reset added in v0.17.24

func (x *ListActiveSchemasResponse) Reset()

func (*ListActiveSchemasResponse) String added in v0.17.24

func (x *ListActiveSchemasResponse) 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 ListSchemaGenerationsRequest added in v0.22.0

type ListSchemaGenerationsRequest struct {

	// Before is used to paginate backwards based on the generation ID.
	Before int64 `protobuf:"varint,1,opt,name=before,proto3" json:"before,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSchemaGenerationsRequest) Descriptor deprecated added in v0.22.0

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

Deprecated: Use ListSchemaGenerationsRequest.ProtoReflect.Descriptor instead.

func (*ListSchemaGenerationsRequest) GetBefore added in v0.22.0

func (x *ListSchemaGenerationsRequest) GetBefore() int64

func (*ListSchemaGenerationsRequest) ProtoMessage added in v0.22.0

func (*ListSchemaGenerationsRequest) ProtoMessage()

func (*ListSchemaGenerationsRequest) ProtoReflect added in v0.22.0

func (*ListSchemaGenerationsRequest) Reset added in v0.22.0

func (x *ListSchemaGenerationsRequest) Reset()

func (*ListSchemaGenerationsRequest) String added in v0.22.0

type ListSchemaGenerationsResponse added in v0.22.0

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

func (*ListSchemaGenerationsResponse) Descriptor deprecated added in v0.22.0

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

Deprecated: Use ListSchemaGenerationsResponse.ProtoReflect.Descriptor instead.

func (*ListSchemaGenerationsResponse) GetItems added in v0.22.0

func (*ListSchemaGenerationsResponse) ProtoMessage added in v0.22.0

func (*ListSchemaGenerationsResponse) ProtoMessage()

func (*ListSchemaGenerationsResponse) ProtoReflect added in v0.22.0

func (*ListSchemaGenerationsResponse) Reset added in v0.22.0

func (x *ListSchemaGenerationsResponse) Reset()

func (*ListSchemaGenerationsResponse) String added in v0.22.0

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 MetaTypeInfo added in v0.17.24

type MetaTypeInfo struct {
	Name   string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	UsedBy []string `protobuf:"bytes,2,rep,name=used_by,json=usedBy,proto3" json:"used_by,omitempty"`
	// contains filtered or unexported fields
}

func (*MetaTypeInfo) Descriptor deprecated added in v0.17.24

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

Deprecated: Use MetaTypeInfo.ProtoReflect.Descriptor instead.

func (*MetaTypeInfo) GetName added in v0.17.24

func (x *MetaTypeInfo) GetName() string

func (*MetaTypeInfo) GetUsedBy added in v0.17.24

func (x *MetaTypeInfo) GetUsedBy() []string

func (*MetaTypeInfo) ProtoMessage added in v0.17.24

func (*MetaTypeInfo) ProtoMessage()

func (*MetaTypeInfo) ProtoReflect added in v0.17.24

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

func (*MetaTypeInfo) Reset added in v0.17.24

func (x *MetaTypeInfo) Reset()

func (*MetaTypeInfo) String added in v0.17.24

func (x *MetaTypeInfo) String() string

type Metric added in v0.17.5

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

func (*Metric) Descriptor deprecated added in v0.17.5

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetKind added in v0.17.5

func (x *Metric) GetKind() string

func (*Metric) GetLabel added in v0.17.5

func (x *Metric) GetLabel() string

func (*Metric) GetValue added in v0.17.5

func (x *Metric) GetValue() int64

func (*Metric) ProtoMessage added in v0.17.5

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect added in v0.17.5

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

func (*Metric) Reset added in v0.17.5

func (x *Metric) Reset()

func (*Metric) String added in v0.17.5

func (x *Metric) 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) Enum

func (MetricAggregation) EnumDescriptor deprecated

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

Deprecated: Use MetricAggregation.Descriptor instead.

func (MetricAggregation) Number

func (MetricAggregation) String

func (x MetricAggregation) String() string

func (MetricAggregation) Type

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)

	// GetMetrics returns metrics related to a document.
	GetMetrics(context.Context, *GetMetricsRequest) (*GetMetricsResponse, 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 PruneRequest added in v0.22.1

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

func (*PruneRequest) Descriptor deprecated added in v0.22.1

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

Deprecated: Use PruneRequest.ProtoReflect.Descriptor instead.

func (*PruneRequest) GetDocument added in v0.22.1

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

func (*PruneRequest) ProtoMessage added in v0.22.1

func (*PruneRequest) ProtoMessage()

func (*PruneRequest) ProtoReflect added in v0.22.1

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

func (*PruneRequest) Reset added in v0.22.1

func (x *PruneRequest) Reset()

func (*PruneRequest) String added in v0.22.1

func (x *PruneRequest) String() string

type PruneResponse added in v0.22.1

type PruneResponse struct {

	// Document is the pruned document.
	Document *newsdoc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Errors are validation issues that could not be resolved by pruning.
	Errors []*ValidationResult `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func (*PruneResponse) Descriptor deprecated added in v0.22.1

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

Deprecated: Use PruneResponse.ProtoReflect.Descriptor instead.

func (*PruneResponse) GetDocument added in v0.22.1

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

func (*PruneResponse) GetErrors added in v0.22.1

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

func (*PruneResponse) ProtoMessage added in v0.22.1

func (*PruneResponse) ProtoMessage()

func (*PruneResponse) ProtoReflect added in v0.22.1

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

func (*PruneResponse) Reset added in v0.22.1

func (x *PruneResponse) Reset()

func (*PruneResponse) String added in v0.22.1

func (x *PruneResponse) String() string

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 RegisterGenerationRequest added in v0.22.0

type RegisterGenerationRequest struct {

	// Schemas to register.
	Schemas []*Schema `protobuf:"bytes,1,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// Activation rule for the registered schema generation.
	Activation SchemaActivation `protobuf:"varint,2,opt,name=activation,proto3,enum=elephant.repository.SchemaActivation" json:"activation,omitempty"`
	// Examplars are documents that serve as examples of what can be expressed
	// with the schemas. If any of the exemplars are invalid the registration
	// request will be rejected.
	Exemplars []*newsdoc.Document `protobuf:"bytes,3,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterGenerationRequest) Descriptor deprecated added in v0.22.0

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

Deprecated: Use RegisterGenerationRequest.ProtoReflect.Descriptor instead.

func (*RegisterGenerationRequest) GetActivation added in v0.22.0

func (x *RegisterGenerationRequest) GetActivation() SchemaActivation

func (*RegisterGenerationRequest) GetExemplars added in v0.22.0

func (x *RegisterGenerationRequest) GetExemplars() []*newsdoc.Document

func (*RegisterGenerationRequest) GetSchemas added in v0.22.0

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

func (*RegisterGenerationRequest) ProtoMessage added in v0.22.0

func (*RegisterGenerationRequest) ProtoMessage()

func (*RegisterGenerationRequest) ProtoReflect added in v0.22.0

func (*RegisterGenerationRequest) Reset added in v0.22.0

func (x *RegisterGenerationRequest) Reset()

func (*RegisterGenerationRequest) String added in v0.22.0

func (x *RegisterGenerationRequest) String() string

type RegisterGenerationResponse added in v0.22.0

type RegisterGenerationResponse struct {

	// GenerationID is the ID of the created schema generation.
	GenerationId int64 `protobuf:"varint,1,opt,name=generation_id,json=generationId,proto3" json:"generation_id,omitempty"`
	// contains filtered or unexported fields
}

func (*RegisterGenerationResponse) Descriptor deprecated added in v0.22.0

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

Deprecated: Use RegisterGenerationResponse.ProtoReflect.Descriptor instead.

func (*RegisterGenerationResponse) GetGenerationId added in v0.22.0

func (x *RegisterGenerationResponse) GetGenerationId() int64

func (*RegisterGenerationResponse) ProtoMessage added in v0.22.0

func (*RegisterGenerationResponse) ProtoMessage()

func (*RegisterGenerationResponse) ProtoReflect added in v0.22.0

func (*RegisterGenerationResponse) Reset added in v0.22.0

func (x *RegisterGenerationResponse) Reset()

func (*RegisterGenerationResponse) String added in v0.22.0

func (x *RegisterGenerationResponse) 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 (*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 (*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 (*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 (*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 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 ScheduledDocument added in v0.17.17

type ScheduledDocument struct {

	// UUID is the ID of the scheduled document.
	Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Type of the scheduled document.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// StatusID is the last withheld status ID.
	StatusId int64 `protobuf:"varint,3,opt,name=status_id,json=statusId,proto3" json:"status_id,omitempty"`
	// DocumentVersion is the last version that was set as withheld.
	DocumentVersion int64 `protobuf:"varint,4,opt,name=document_version,json=documentVersion,proto3" json:"document_version,omitempty"`
	// PlanningItem UUID.
	PlanningItem string `protobuf:"bytes,5,opt,name=planning_item,json=planningItem,proto3" json:"planning_item,omitempty"`
	// Assignment ID.
	Assignment string `protobuf:"bytes,6,opt,name=assignment,proto3" json:"assignment,omitempty"`
	// Publish timestamp as RFC3339 set in the assignment.
	Publish string `protobuf:"bytes,7,opt,name=publish,proto3" json:"publish,omitempty"`
	// ScheduledBy is the sub of the user that set the withheld status.
	ScheduledBy string `protobuf:"bytes,8,opt,name=scheduled_by,json=scheduledBy,proto3" json:"scheduled_by,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduledDocument) Descriptor deprecated added in v0.17.17

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

Deprecated: Use ScheduledDocument.ProtoReflect.Descriptor instead.

func (*ScheduledDocument) GetAssignment added in v0.17.17

func (x *ScheduledDocument) GetAssignment() string

func (*ScheduledDocument) GetDocumentVersion added in v0.17.17

func (x *ScheduledDocument) GetDocumentVersion() int64

func (*ScheduledDocument) GetPlanningItem added in v0.17.17

func (x *ScheduledDocument) GetPlanningItem() string

func (*ScheduledDocument) GetPublish added in v0.17.17

func (x *ScheduledDocument) GetPublish() string

func (*ScheduledDocument) GetScheduledBy added in v0.17.17

func (x *ScheduledDocument) GetScheduledBy() string

func (*ScheduledDocument) GetStatusId added in v0.17.17

func (x *ScheduledDocument) GetStatusId() int64

func (*ScheduledDocument) GetType added in v0.17.17

func (x *ScheduledDocument) GetType() string

func (*ScheduledDocument) GetUuid added in v0.17.17

func (x *ScheduledDocument) GetUuid() string

func (*ScheduledDocument) ProtoMessage added in v0.17.17

func (*ScheduledDocument) ProtoMessage()

func (*ScheduledDocument) ProtoReflect added in v0.17.17

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

func (*ScheduledDocument) Reset added in v0.17.17

func (x *ScheduledDocument) Reset()

func (*ScheduledDocument) String added in v0.17.17

func (x *ScheduledDocument) 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 SchemaActivation added in v0.22.0

type SchemaActivation int32
const (
	// No activation status.
	SchemaActivation_ACTIVATION_UNKNOWN SchemaActivation = 0
	// Active schema generations are used to determine whether documents are valid.
	SchemaActivation_ACTIVATION_ACTIVE SchemaActivation = 1
	// Pending schema generations are used for soft validation and we log
	// validation errors for it. The currently active schema generation still has
	// the last say in whether a document is valid or not.
	SchemaActivation_ACTIVATION_PENDING SchemaActivation = 2
	// Deactivated schema generation.
	SchemaActivation_ACTIVATION_DEACTIVATED SchemaActivation = 3
)

func (SchemaActivation) Descriptor added in v0.22.0

func (SchemaActivation) Enum added in v0.22.0

func (SchemaActivation) EnumDescriptor deprecated added in v0.22.0

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

Deprecated: Use SchemaActivation.Descriptor instead.

func (SchemaActivation) Number added in v0.22.0

func (SchemaActivation) String added in v0.22.0

func (x SchemaActivation) String() string

func (SchemaActivation) Type added in v0.22.0

type SchemaGeneration added in v0.22.0

type SchemaGeneration struct {

	// ID of the schema generation.
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// Status of the generation.
	Status SchemaActivation `protobuf:"varint,2,opt,name=status,proto3,enum=elephant.repository.SchemaActivation" json:"status,omitempty"`
	// Created is the time (RFC3339) the schema generation was first registered.
	Created string `protobuf:"bytes,3,opt,name=created,proto3" json:"created,omitempty"`
	// Activated is the time (RFC3339) the schema generation was last activated (if it has been activated).
	Activated string `protobuf:"bytes,4,opt,name=activated,proto3" json:"activated,omitempty"`
	// Deactivated is the time (RFC3339) the schema generation was last deactivated (if it has been deactivated).
	Deactivated string `protobuf:"bytes,5,opt,name=deactivated,proto3" json:"deactivated,omitempty"`
	// Schemas are the schemas that are included in the generation.
	Schemas []*SchemaReference `protobuf:"bytes,6,rep,name=schemas,proto3" json:"schemas,omitempty"`
	// contains filtered or unexported fields
}

func (*SchemaGeneration) Descriptor deprecated added in v0.22.0

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

Deprecated: Use SchemaGeneration.ProtoReflect.Descriptor instead.

func (*SchemaGeneration) GetActivated added in v0.22.0

func (x *SchemaGeneration) GetActivated() string

func (*SchemaGeneration) GetCreated added in v0.22.0

func (x *SchemaGeneration) GetCreated() string

func (*SchemaGeneration) GetDeactivated added in v0.22.0

func (x *SchemaGeneration) GetDeactivated() string

func (*SchemaGeneration) GetId added in v0.22.0

func (x *SchemaGeneration) GetId() int64

func (*SchemaGeneration) GetSchemas added in v0.22.0

func (x *SchemaGeneration) GetSchemas() []*SchemaReference

func (*SchemaGeneration) GetStatus added in v0.22.0

func (x *SchemaGeneration) GetStatus() SchemaActivation

func (*SchemaGeneration) ProtoMessage added in v0.22.0

func (*SchemaGeneration) ProtoMessage()

func (*SchemaGeneration) ProtoReflect added in v0.22.0

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

func (*SchemaGeneration) Reset added in v0.22.0

func (x *SchemaGeneration) Reset()

func (*SchemaGeneration) String added in v0.22.0

func (x *SchemaGeneration) String() string

type SchemaReference added in v0.22.0

type SchemaReference 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"`
	// contains filtered or unexported fields
}

func (*SchemaReference) Descriptor deprecated added in v0.22.0

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

Deprecated: Use SchemaReference.ProtoReflect.Descriptor instead.

func (*SchemaReference) GetName added in v0.22.0

func (x *SchemaReference) GetName() string

func (*SchemaReference) GetVersion added in v0.22.0

func (x *SchemaReference) GetVersion() string

func (*SchemaReference) ProtoMessage added in v0.22.0

func (*SchemaReference) ProtoMessage()

func (*SchemaReference) ProtoReflect added in v0.22.0

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

func (*SchemaReference) Reset added in v0.22.0

func (x *SchemaReference) Reset()

func (*SchemaReference) String added in v0.22.0

func (x *SchemaReference) String() string

type Schemas

type Schemas interface {
	// RegisterGeneration registers a new schema generation. Registration is
	// idempotent, so calling RegisterGeneration with the same schema versions
	// will yield the same generation ID.
	RegisterGeneration(context.Context, *RegisterGenerationRequest) (*RegisterGenerationResponse, error)

	// SetActive activates or deactivates a schema generation. Activating a
	// generation always deactivates the currently active schema generation.
	// Deactivation is only relevant in the context of pending schema
	// generations, because deactivating an active schema generation isn't
	// allowed.
	SetActive(context.Context, *SetActiveSchemasRequest) (*SetActiveSchemasResponse, error)

	// ListGenerations lists the configured schema generations.
	ListGenerations(context.Context, *ListSchemaGenerationsRequest) (*ListSchemaGenerationsResponse, error)

	// GetExemplars returns the exemplar documents for a schema generation. Known
	// exemplar version hashes can be provided to avoid re-transferring unchanged
	// documents.
	GetExemplars(context.Context, *GetExemplarsRequest) (*GetExemplarsResponse, error)

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

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

	// ListActiveSchemas lists the currently active schemas.
	ListActive(context.Context, *ListActiveSchemasRequest) (*ListActiveSchemasResponse, 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)

	// GetMetaTypes lists the registered meta types.
	GetMetaTypes(context.Context, *GetMetaTypesRequest) (*GetMetaTypesResponse, error)

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

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

	// GetDocumentTypes lists the defined document types.
	GetDocumentTypes(context.Context, *GetDocumentTypesRequest) (*GetDocumentTypesResponse, error)

	// ConfigureType configures a document type.
	ConfigureType(context.Context, *ConfigureTypeRequest) (*ConfigureTypeResponse, error)

	// GetTypeConfiguration returns the current configuration for a type.
	GetTypeConfiguration(context.Context, *GetTypeConfigurationRequest) (*GetTypeConfigurationResponse, 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 SetActiveSchemasRequest added in v0.22.0

type SetActiveSchemasRequest struct {

	// GenerationID is the ID of the generation to activate.
	GenerationId int64 `protobuf:"varint,1,opt,name=generation_id,json=generationId,proto3" json:"generation_id,omitempty"`
	// Activation setting.
	Activation SchemaActivation `protobuf:"varint,2,opt,name=activation,proto3,enum=elephant.repository.SchemaActivation" json:"activation,omitempty"`
	// contains filtered or unexported fields
}

func (*SetActiveSchemasRequest) Descriptor deprecated added in v0.22.0

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

Deprecated: Use SetActiveSchemasRequest.ProtoReflect.Descriptor instead.

func (*SetActiveSchemasRequest) GetActivation added in v0.22.0

func (x *SetActiveSchemasRequest) GetActivation() SchemaActivation

func (*SetActiveSchemasRequest) GetGenerationId added in v0.22.0

func (x *SetActiveSchemasRequest) GetGenerationId() int64

func (*SetActiveSchemasRequest) ProtoMessage added in v0.22.0

func (*SetActiveSchemasRequest) ProtoMessage()

func (*SetActiveSchemasRequest) ProtoReflect added in v0.22.0

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

func (*SetActiveSchemasRequest) Reset added in v0.22.0

func (x *SetActiveSchemasRequest) Reset()

func (*SetActiveSchemasRequest) String added in v0.22.0

func (x *SetActiveSchemasRequest) String() string

type SetActiveSchemasResponse added in v0.22.0

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

func (*SetActiveSchemasResponse) Descriptor deprecated added in v0.22.0

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

Deprecated: Use SetActiveSchemasResponse.ProtoReflect.Descriptor instead.

func (*SetActiveSchemasResponse) ProtoMessage added in v0.22.0

func (*SetActiveSchemasResponse) ProtoMessage()

func (*SetActiveSchemasResponse) ProtoReflect added in v0.22.0

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

func (*SetActiveSchemasResponse) Reset added in v0.22.0

func (x *SetActiveSchemasResponse) Reset()

func (*SetActiveSchemasResponse) String added in v0.22.0

func (x *SetActiveSchemasResponse) String() string

type SetWorkflowRequest added in v0.17.7

type SetWorkflowRequest struct {

	// Type of the document that this workflow is for.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Workflow declaration.
	Workflow *DocumentWorkflow `protobuf:"bytes,2,opt,name=workflow,proto3" json:"workflow,omitempty"`
	// contains filtered or unexported fields
}

func (*SetWorkflowRequest) Descriptor deprecated added in v0.17.7

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

Deprecated: Use SetWorkflowRequest.ProtoReflect.Descriptor instead.

func (*SetWorkflowRequest) GetType added in v0.17.7

func (x *SetWorkflowRequest) GetType() string

func (*SetWorkflowRequest) GetWorkflow added in v0.17.7

func (x *SetWorkflowRequest) GetWorkflow() *DocumentWorkflow

func (*SetWorkflowRequest) ProtoMessage added in v0.17.7

func (*SetWorkflowRequest) ProtoMessage()

func (*SetWorkflowRequest) ProtoReflect added in v0.17.7

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

func (*SetWorkflowRequest) Reset added in v0.17.7

func (x *SetWorkflowRequest) Reset()

func (*SetWorkflowRequest) String added in v0.17.7

func (x *SetWorkflowRequest) String() string

type SetWorkflowResponse added in v0.17.7

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

func (*SetWorkflowResponse) Descriptor deprecated added in v0.17.7

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

Deprecated: Use SetWorkflowResponse.ProtoReflect.Descriptor instead.

func (*SetWorkflowResponse) ProtoMessage added in v0.17.7

func (*SetWorkflowResponse) ProtoMessage()

func (*SetWorkflowResponse) ProtoReflect added in v0.17.7

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

func (*SetWorkflowResponse) Reset added in v0.17.7

func (x *SetWorkflowResponse) Reset()

func (*SetWorkflowResponse) String added in v0.17.7

func (x *SetWorkflowResponse) 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 `` /* 135-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 is the current version (last written version) of the document.
	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 `` /* 137-byte string literal not displayed */
	// WorkflowState that the document is in.
	WorkflowState string `protobuf:"bytes,5,opt,name=workflow_state,json=workflowState,proto3" json:"workflow_state,omitempty"`
	// WorkflowCheckpoint that the document reached most recently.
	WorkflowCheckpoint string `protobuf:"bytes,6,opt,name=workflow_checkpoint,json=workflowCheckpoint,proto3" json:"workflow_checkpoint,omitempty"`
	// CreatorURI is the URI of the subject that created the document.
	CreatorUri string `protobuf:"bytes,7,opt,name=creator_uri,json=creatorUri,proto3" json:"creator_uri,omitempty"`
	// UpdaterURI is the URI of the subject that last updated the document.
	UpdaterUri string `protobuf:"bytes,8,opt,name=updater_uri,json=updaterUri,proto3" json:"updater_uri,omitempty"`
	// 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) GetCreatorUri added in v0.18.2

func (x *StatusOverviewItem) GetCreatorUri() string

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) GetUpdaterUri added in v0.18.2

func (x *StatusOverviewItem) GetUpdaterUri() 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) GetWorkflowCheckpoint added in v0.17.22

func (x *StatusOverviewItem) GetWorkflowCheckpoint() string

func (*StatusOverviewItem) GetWorkflowState added in v0.17.22

func (x *StatusOverviewItem) GetWorkflowState() string

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 `` /* 135-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 Timespan added in v0.19.0

type Timespan struct {
	From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty"`
	To   string `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
	// contains filtered or unexported fields
}

func (*Timespan) Descriptor deprecated added in v0.19.0

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

Deprecated: Use Timespan.ProtoReflect.Descriptor instead.

func (*Timespan) GetFrom added in v0.19.0

func (x *Timespan) GetFrom() string

func (*Timespan) GetTo added in v0.19.0

func (x *Timespan) GetTo() string

func (*Timespan) ProtoMessage added in v0.19.0

func (*Timespan) ProtoMessage()

func (*Timespan) ProtoReflect added in v0.19.0

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

func (*Timespan) Reset added in v0.19.0

func (x *Timespan) Reset()

func (*Timespan) String added in v0.19.0

func (x *Timespan) 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 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 TypeConfiguration added in v0.19.0

type TypeConfiguration struct {

	// Set to true if this is a collection of documents that are bounded (limited
	// in size). Bounded collections can be fetched by type and language in one
	// go.
	BoundedCollection bool `protobuf:"varint,1,opt,name=bounded_collection,json=boundedCollection,proto3" json:"bounded_collection,omitempty"`
	// TimeExpressions are used for extracting time ranges from documents.
	TimeExpressions []*TypeTimeExpression `protobuf:"bytes,2,rep,name=time_expressions,json=timeExpressions,proto3" json:"time_expressions,omitempty"`
	// LabelExpressions are used to extract labels from documents.
	LabelExpressions []*LabelExpression `protobuf:"bytes,3,rep,name=label_expressions,json=labelExpressions,proto3" json:"label_expressions,omitempty"`
	// Variants are the allowed variants for the document type.
	Variants []string `protobuf:"bytes,4,rep,name=variants,proto3" json:"variants,omitempty"`
	// EvictNonCurrentAfter can be set to evict non-current versions of a
	// document from the database after they're older than the given number of
	// days. Optional.
	EvictNoncurrentAfter int64 `protobuf:"varint,5,opt,name=evict_noncurrent_after,json=evictNoncurrentAfter,proto3" json:"evict_noncurrent_after,omitempty"`
	// contains filtered or unexported fields
}

func (*TypeConfiguration) Descriptor deprecated added in v0.19.0

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

Deprecated: Use TypeConfiguration.ProtoReflect.Descriptor instead.

func (*TypeConfiguration) GetBoundedCollection added in v0.19.0

func (x *TypeConfiguration) GetBoundedCollection() bool

func (*TypeConfiguration) GetEvictNoncurrentAfter added in v0.21.3

func (x *TypeConfiguration) GetEvictNoncurrentAfter() int64

func (*TypeConfiguration) GetLabelExpressions added in v0.19.0

func (x *TypeConfiguration) GetLabelExpressions() []*LabelExpression

func (*TypeConfiguration) GetTimeExpressions added in v0.19.0

func (x *TypeConfiguration) GetTimeExpressions() []*TypeTimeExpression

func (*TypeConfiguration) GetVariants added in v0.21.0

func (x *TypeConfiguration) GetVariants() []string

func (*TypeConfiguration) ProtoMessage added in v0.19.0

func (*TypeConfiguration) ProtoMessage()

func (*TypeConfiguration) ProtoReflect added in v0.19.0

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

func (*TypeConfiguration) Reset added in v0.19.0

func (x *TypeConfiguration) Reset()

func (*TypeConfiguration) String added in v0.19.0

func (x *TypeConfiguration) String() string

type TypeTimeExpression added in v0.19.0

type TypeTimeExpression struct {

	// Expression is a newsdoc value extraction expression.
	Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"`
	// Layout is the time/date format to use when parsing. Optional, defaults to
	// RFC3339 or ISO 8601 for values annotated as dates.
	Layout string `protobuf:"bytes,2,opt,name=layout,proto3" json:"layout,omitempty"`
	// Timezone is the timezone the time should be parsed in. Optional, most
	// timestamps should include timezone information, if they don't, parsing will
	// fall back to the default timezone that the repository has been configured
	// with.
	Timezone string `protobuf:"bytes,3,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// contains filtered or unexported fields
}

func (*TypeTimeExpression) Descriptor deprecated added in v0.19.0

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

Deprecated: Use TypeTimeExpression.ProtoReflect.Descriptor instead.

func (*TypeTimeExpression) GetExpression added in v0.19.0

func (x *TypeTimeExpression) GetExpression() string

func (*TypeTimeExpression) GetLayout added in v0.19.0

func (x *TypeTimeExpression) GetLayout() string

func (*TypeTimeExpression) GetTimezone added in v0.19.0

func (x *TypeTimeExpression) GetTimezone() string

func (*TypeTimeExpression) ProtoMessage added in v0.19.0

func (*TypeTimeExpression) ProtoMessage()

func (*TypeTimeExpression) ProtoReflect added in v0.19.0

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

func (*TypeTimeExpression) Reset added in v0.19.0

func (x *TypeTimeExpression) Reset()

func (*TypeTimeExpression) String added in v0.19.0

func (x *TypeTimeExpression) String() string

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 (*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 (*UpdatePermissionsResponse) Reset

func (x *UpdatePermissionsResponse) Reset()

func (*UpdatePermissionsResponse) String

func (x *UpdatePermissionsResponse) 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 `` /* 135-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"`
	// IfWorkflowState is used to only perform the update if it's in the specified
	// workflow state.
	IfWorkflowState string `protobuf:"bytes,10,opt,name=if_workflow_state,json=ifWorkflowState,proto3" json:"if_workflow_state,omitempty"`
	// IfStatusHeads is used to only perform the update if the status heads match.
	IfStatusHeads map[string]int64 `` /* 178-byte string literal not displayed */
	// AttachObjects is used to attach uploaded objects to a document. This must
	// be done in combination with a document create or update. The key is the
	// object name, f.ex. "image" or "audio", and the value is an upload ID. See
	// CreateUpload().
	AttachObjects map[string]string `` /* 175-byte string literal not displayed */
	// DetatchObjects is used to detach uploaded objects from a document. This
	// must be done in combination with a document create or update.
	DetachObjects []string `protobuf:"bytes,13,rep,name=detach_objects,json=detachObjects,proto3" json:"detach_objects,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) GetAttachObjects added in v0.17.18

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

func (*UpdateRequest) GetDetachObjects added in v0.17.18

func (x *UpdateRequest) GetDetachObjects() []string

func (*UpdateRequest) GetDocument

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

func (*UpdateRequest) GetIfMatch

func (x *UpdateRequest) GetIfMatch() int64

func (*UpdateRequest) GetIfStatusHeads added in v0.17.17

func (x *UpdateRequest) GetIfStatusHeads() map[string]int64

func (*UpdateRequest) GetIfWorkflowState added in v0.17.17

func (x *UpdateRequest) GetIfWorkflowState() string

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)

	// SetWorkflow configures a workflow for a document type.
	SetWorkflow(context.Context, *SetWorkflowRequest) (*SetWorkflowResponse, error)

	// GetWorkflow for a document type.
	GetWorkflow(context.Context, *GetWorkflowRequest) (*GetWorkflowResponse, error)

	// DeleteWorkflow removes the workflow configuration for a document type.
	DeleteWorkflow(context.Context, *DeleteWorkflowRequest) (*DeleteWorkflowResponse, 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL