exemplar

package
v0.0.0-...-8b05a81 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2021 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterExemplarsServer 

func RegisterExemplarsServer(s *grpc.Server, srv ExemplarsServer)

Types

type CreateExemplarRequest 

type CreateExemplarRequest struct {
	// The name of the exemplar .. aka the form name or Id. Must be unique
	// within the account and must also match the regex '^[0-9A-Za-z.-]{1,48}$'.
	// If not supplied, a satisfactory name is automatically generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// For client use.  Optional.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Any metadata of the client's choosing. Limit to a few KB. Optional.
	Metadata *any.Any `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The name of an uploaded PDF or uploaded dimensioned image.
	ImageOrPdfName string `protobuf:"bytes,4,opt,name=image_or_pdf_name,json=imageOrPdfName,proto3" json:"image_or_pdf_name,omitempty"`
	// If registering a page within a PDF, the 1-based page number within the PDF
	// to be used as the exemplar. The page must have been designated as being a
	// page of interest during the original PDF upload. Do not set if creating an
	// exemplar from an image.
	PageNumber int32 `protobuf:"varint,5,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	// The dominant printed language.
	Language             ntypes.Language `protobuf:"varint,6,opt,name=language,proto3,enum=nsys.api.ntypes.Language" json:"language,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*CreateExemplarRequest) Descriptor 

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

func (*CreateExemplarRequest) GetDescription 

func (m *CreateExemplarRequest) GetDescription() string

func (*CreateExemplarRequest) GetImageOrPdfName 

func (m *CreateExemplarRequest) GetImageOrPdfName() string

func (*CreateExemplarRequest) GetLanguage 

func (m *CreateExemplarRequest) GetLanguage() ntypes.Language

func (*CreateExemplarRequest) GetMetadata 

func (m *CreateExemplarRequest) GetMetadata() *any.Any

func (*CreateExemplarRequest) GetName 

func (m *CreateExemplarRequest) GetName() string

func (*CreateExemplarRequest) GetPageNumber 

func (m *CreateExemplarRequest) GetPageNumber() int32

func (*CreateExemplarRequest) ProtoMessage 

func (*CreateExemplarRequest) ProtoMessage()

func (*CreateExemplarRequest) Reset 

func (m *CreateExemplarRequest) Reset()

func (*CreateExemplarRequest) String 

func (m *CreateExemplarRequest) String() string

func (*CreateExemplarRequest) XXX_DiscardUnknown 

func (m *CreateExemplarRequest) XXX_DiscardUnknown()

func (*CreateExemplarRequest) XXX_Marshal 

func (m *CreateExemplarRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateExemplarRequest) XXX_Merge 

func (m *CreateExemplarRequest) XXX_Merge(src proto.Message)

func (*CreateExemplarRequest) XXX_Size 

func (m *CreateExemplarRequest) XXX_Size() int

func (*CreateExemplarRequest) XXX_Unmarshal 

func (m *CreateExemplarRequest) XXX_Unmarshal(b []byte) error

type CreateExemplarResponse 

type CreateExemplarResponse struct {
	// The specified or generated identifier for the exemplar.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreateExemplarResponse) Descriptor 

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

func (*CreateExemplarResponse) GetName 

func (m *CreateExemplarResponse) GetName() string

func (*CreateExemplarResponse) ProtoMessage 

func (*CreateExemplarResponse) ProtoMessage()

func (*CreateExemplarResponse) Reset 

func (m *CreateExemplarResponse) Reset()

func (*CreateExemplarResponse) String 

func (m *CreateExemplarResponse) String() string

func (*CreateExemplarResponse) XXX_DiscardUnknown 

func (m *CreateExemplarResponse) XXX_DiscardUnknown()

func (*CreateExemplarResponse) XXX_Marshal 

func (m *CreateExemplarResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateExemplarResponse) XXX_Merge 

func (m *CreateExemplarResponse) XXX_Merge(src proto.Message)

func (*CreateExemplarResponse) XXX_Size 

func (m *CreateExemplarResponse) XXX_Size() int

func (*CreateExemplarResponse) XXX_Unmarshal 

func (m *CreateExemplarResponse) XXX_Unmarshal(b []byte) error

type CreateFieldRequest 

type CreateFieldRequest struct {
	// The identifier for the exemplar that the field is being defined in.
	ExemplarName string `protobuf:"bytes,1,opt,name=exemplar_name,json=exemplarName,proto3" json:"exemplar_name,omitempty"`
	// The actual field definition. If the field definition contains no name,
	// a satisfactory name is automatically generated and returned in the
	// response.
	Field                *ntypes.Field `protobuf:"bytes,2,opt,name=field,proto3" json:"field,omitempty"`
	XXX_NoUnkeyedLiteral struct{}      `json:"-"`
	XXX_unrecognized     []byte        `json:"-"`
	XXX_sizecache        int32         `json:"-"`
}

func (*CreateFieldRequest) Descriptor 

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

func (*CreateFieldRequest) GetExemplarName 

func (m *CreateFieldRequest) GetExemplarName() string

func (*CreateFieldRequest) GetField 

func (m *CreateFieldRequest) GetField() *ntypes.Field

func (*CreateFieldRequest) ProtoMessage 

func (*CreateFieldRequest) ProtoMessage()

func (*CreateFieldRequest) Reset 

func (m *CreateFieldRequest) Reset()

func (*CreateFieldRequest) String 

func (m *CreateFieldRequest) String() string

func (*CreateFieldRequest) XXX_DiscardUnknown 

func (m *CreateFieldRequest) XXX_DiscardUnknown()

func (*CreateFieldRequest) XXX_Marshal 

func (m *CreateFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateFieldRequest) XXX_Merge 

func (m *CreateFieldRequest) XXX_Merge(src proto.Message)

func (*CreateFieldRequest) XXX_Size 

func (m *CreateFieldRequest) XXX_Size() int

func (*CreateFieldRequest) XXX_Unmarshal 

func (m *CreateFieldRequest) XXX_Unmarshal(b []byte) error

type CreateFieldResponse 

type CreateFieldResponse struct {
	ExemplarName         string   `protobuf:"bytes,1,opt,name=exemplar_name,json=exemplarName,proto3" json:"exemplar_name,omitempty"`
	FieldName            string   `protobuf:"bytes,2,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreateFieldResponse) Descriptor 

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

func (*CreateFieldResponse) GetExemplarName 

func (m *CreateFieldResponse) GetExemplarName() string

func (*CreateFieldResponse) GetFieldName 

func (m *CreateFieldResponse) GetFieldName() string

func (*CreateFieldResponse) ProtoMessage 

func (*CreateFieldResponse) ProtoMessage()

func (*CreateFieldResponse) Reset 

func (m *CreateFieldResponse) Reset()

func (*CreateFieldResponse) String 

func (m *CreateFieldResponse) String() string

func (*CreateFieldResponse) XXX_DiscardUnknown 

func (m *CreateFieldResponse) XXX_DiscardUnknown()

func (*CreateFieldResponse) XXX_Marshal 

func (m *CreateFieldResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateFieldResponse) XXX_Merge 

func (m *CreateFieldResponse) XXX_Merge(src proto.Message)

func (*CreateFieldResponse) XXX_Size 

func (m *CreateFieldResponse) XXX_Size() int

func (*CreateFieldResponse) XXX_Unmarshal 

func (m *CreateFieldResponse) XXX_Unmarshal(b []byte) error

type DeleteExemplarRequest 

type DeleteExemplarRequest struct {
	// The name of the exemplar to delete.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeleteExemplarRequest) Descriptor 

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

func (*DeleteExemplarRequest) GetName 

func (m *DeleteExemplarRequest) GetName() string

func (*DeleteExemplarRequest) ProtoMessage 

func (*DeleteExemplarRequest) ProtoMessage()

func (*DeleteExemplarRequest) Reset 

func (m *DeleteExemplarRequest) Reset()

func (*DeleteExemplarRequest) String 

func (m *DeleteExemplarRequest) String() string

func (*DeleteExemplarRequest) XXX_DiscardUnknown 

func (m *DeleteExemplarRequest) XXX_DiscardUnknown()

func (*DeleteExemplarRequest) XXX_Marshal 

func (m *DeleteExemplarRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteExemplarRequest) XXX_Merge 

func (m *DeleteExemplarRequest) XXX_Merge(src proto.Message)

func (*DeleteExemplarRequest) XXX_Size 

func (m *DeleteExemplarRequest) XXX_Size() int

func (*DeleteExemplarRequest) XXX_Unmarshal 

func (m *DeleteExemplarRequest) XXX_Unmarshal(b []byte) error

type DeleteFieldRequest 

type DeleteFieldRequest struct {
	// The identifier for the exemplar that the field is defined in.
	ExemplarName string `protobuf:"bytes,1,opt,name=exemplar_name,json=exemplarName,proto3" json:"exemplar_name,omitempty"`
	// The identifier for the field within the exemplar.
	Name                 string   `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DeleteFieldRequest) Descriptor 

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

func (*DeleteFieldRequest) GetExemplarName 

func (m *DeleteFieldRequest) GetExemplarName() string

func (*DeleteFieldRequest) GetName 

func (m *DeleteFieldRequest) GetName() string

func (*DeleteFieldRequest) ProtoMessage 

func (*DeleteFieldRequest) ProtoMessage()

func (*DeleteFieldRequest) Reset 

func (m *DeleteFieldRequest) Reset()

func (*DeleteFieldRequest) String 

func (m *DeleteFieldRequest) String() string

func (*DeleteFieldRequest) XXX_DiscardUnknown 

func (m *DeleteFieldRequest) XXX_DiscardUnknown()

func (*DeleteFieldRequest) XXX_Marshal 

func (m *DeleteFieldRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteFieldRequest) XXX_Merge 

func (m *DeleteFieldRequest) XXX_Merge(src proto.Message)

func (*DeleteFieldRequest) XXX_Size 

func (m *DeleteFieldRequest) XXX_Size() int

func (*DeleteFieldRequest) XXX_Unmarshal 

func (m *DeleteFieldRequest) XXX_Unmarshal(b []byte) error

type ExemplarsClient 

type ExemplarsClient interface {
	// Upload a dimensioned image.
	// This image should be pristine, upright, and deskewed.
	UploadDimensionedImage(ctx context.Context, in *UploadDimensionedImageRequest, opts ...grpc.CallOption) (*UploadDimensionedImageResponse, error)
	UploadDimensionedImageLRO(ctx context.Context, in *UploadDimensionedImageRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Upload a PDF. The specified (or all) of its pages are rendered and oriented
	// before the operation is complete.
	UploadPdf(ctx context.Context, in *UploadPdfRequest, opts ...grpc.CallOption) (*UploadPdfResponse, error)
	UploadPdfLRO(ctx context.Context, in *UploadPdfRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Fetch a previously uploaded PDF page.
	GetPdfPage(ctx context.Context, in *GetPdfPageRequest, opts ...grpc.CallOption) (*GetPdfPageResponse, error)
	GetPdfPageLRO(ctx context.Context, in *GetPdfPageRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Register a dimensioned image or PDF page as being an exemplar. Once
	// registered, the image becomes independently associated with the exemplar
	// name and will not expire.
	CreateExemplar(ctx context.Context, in *CreateExemplarRequest, opts ...grpc.CallOption) (*CreateExemplarResponse, error)
	CreateExemplarLRO(ctx context.Context, in *CreateExemplarRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Returns information on existing exemplars.
	ListExemplars(ctx context.Context, in *ListExemplarsRequest, opts ...grpc.CallOption) (*ListExemplarsResponse, error)
	ListExemplarsLRO(ctx context.Context, in *ListExemplarsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Fetch an exemplar.
	GetExemplar(ctx context.Context, in *GetExemplarRequest, opts ...grpc.CallOption) (*GetExemplarResponse, error)
	GetExemplarLRO(ctx context.Context, in *GetExemplarRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Permanently delete an exemplar and all dependent objects (i.e., fields).
	DeleteExemplar(ctx context.Context, in *DeleteExemplarRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	DeleteExemplarLRO(ctx context.Context, in *DeleteExemplarRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Define a data collection field on an exemplar.
	CreateField(ctx context.Context, in *CreateFieldRequest, opts ...grpc.CallOption) (*CreateFieldResponse, error)
	CreateFieldLRO(ctx context.Context, in *CreateFieldRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Remove a field from an exemplar.
	DeleteField(ctx context.Context, in *DeleteFieldRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	DeleteFieldLRO(ctx context.Context, in *DeleteFieldRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Returns the fields defined on the specified exemplar.
	ListFields(ctx context.Context, in *ListFieldsRequest, opts ...grpc.CallOption) (*ListFieldsResponse, error)
	ListFieldsLRO(ctx context.Context, in *ListFieldsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

ExemplarsClient is the client API for Exemplars service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewExemplarsClient 

func NewExemplarsClient(cc *grpc.ClientConn) ExemplarsClient

type ExemplarsServer 

type ExemplarsServer interface {
	// Upload a dimensioned image.
	// This image should be pristine, upright, and deskewed.
	UploadDimensionedImage(context.Context, *UploadDimensionedImageRequest) (*UploadDimensionedImageResponse, error)
	UploadDimensionedImageLRO(context.Context, *UploadDimensionedImageRequest) (*longrunning.Operation, error)
	// Upload a PDF. The specified (or all) of its pages are rendered and oriented
	// before the operation is complete.
	UploadPdf(context.Context, *UploadPdfRequest) (*UploadPdfResponse, error)
	UploadPdfLRO(context.Context, *UploadPdfRequest) (*longrunning.Operation, error)
	// Fetch a previously uploaded PDF page.
	GetPdfPage(context.Context, *GetPdfPageRequest) (*GetPdfPageResponse, error)
	GetPdfPageLRO(context.Context, *GetPdfPageRequest) (*longrunning.Operation, error)
	// Register a dimensioned image or PDF page as being an exemplar. Once
	// registered, the image becomes independently associated with the exemplar
	// name and will not expire.
	CreateExemplar(context.Context, *CreateExemplarRequest) (*CreateExemplarResponse, error)
	CreateExemplarLRO(context.Context, *CreateExemplarRequest) (*longrunning.Operation, error)
	// Returns information on existing exemplars.
	ListExemplars(context.Context, *ListExemplarsRequest) (*ListExemplarsResponse, error)
	ListExemplarsLRO(context.Context, *ListExemplarsRequest) (*longrunning.Operation, error)
	// Fetch an exemplar.
	GetExemplar(context.Context, *GetExemplarRequest) (*GetExemplarResponse, error)
	GetExemplarLRO(context.Context, *GetExemplarRequest) (*longrunning.Operation, error)
	// Permanently delete an exemplar and all dependent objects (i.e., fields).
	DeleteExemplar(context.Context, *DeleteExemplarRequest) (*empty.Empty, error)
	DeleteExemplarLRO(context.Context, *DeleteExemplarRequest) (*longrunning.Operation, error)
	// Define a data collection field on an exemplar.
	CreateField(context.Context, *CreateFieldRequest) (*CreateFieldResponse, error)
	CreateFieldLRO(context.Context, *CreateFieldRequest) (*longrunning.Operation, error)
	// Remove a field from an exemplar.
	DeleteField(context.Context, *DeleteFieldRequest) (*empty.Empty, error)
	DeleteFieldLRO(context.Context, *DeleteFieldRequest) (*longrunning.Operation, error)
	// Returns the fields defined on the specified exemplar.
	ListFields(context.Context, *ListFieldsRequest) (*ListFieldsResponse, error)
	ListFieldsLRO(context.Context, *ListFieldsRequest) (*longrunning.Operation, error)
}

ExemplarsServer is the server API for Exemplars service.

type GetExemplarRequest 

type GetExemplarRequest struct {
	// Return the specified exemplar.
	ExemplarName string `protobuf:"bytes,1,opt,name=exemplar_name,json=exemplarName,proto3" json:"exemplar_name,omitempty"`
	// Set true if the returned exemplar is to include the full image data.
	IncludeImage         bool     `protobuf:"varint,2,opt,name=include_image,json=includeImage,proto3" json:"include_image,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetExemplarRequest) Descriptor 

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

func (*GetExemplarRequest) GetExemplarName 

func (m *GetExemplarRequest) GetExemplarName() string

func (*GetExemplarRequest) GetIncludeImage 

func (m *GetExemplarRequest) GetIncludeImage() bool

func (*GetExemplarRequest) ProtoMessage 

func (*GetExemplarRequest) ProtoMessage()

func (*GetExemplarRequest) Reset 

func (m *GetExemplarRequest) Reset()

func (*GetExemplarRequest) String 

func (m *GetExemplarRequest) String() string

func (*GetExemplarRequest) XXX_DiscardUnknown 

func (m *GetExemplarRequest) XXX_DiscardUnknown()

func (*GetExemplarRequest) XXX_Marshal 

func (m *GetExemplarRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetExemplarRequest) XXX_Merge 

func (m *GetExemplarRequest) XXX_Merge(src proto.Message)

func (*GetExemplarRequest) XXX_Size 

func (m *GetExemplarRequest) XXX_Size() int

func (*GetExemplarRequest) XXX_Unmarshal 

func (m *GetExemplarRequest) XXX_Unmarshal(b []byte) error

type GetExemplarResponse 

type GetExemplarResponse struct {
	Exemplar             *ntypes.Exemplar `protobuf:"bytes,1,opt,name=exemplar,proto3" json:"exemplar,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*GetExemplarResponse) Descriptor 

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

func (*GetExemplarResponse) GetExemplar 

func (m *GetExemplarResponse) GetExemplar() *ntypes.Exemplar

func (*GetExemplarResponse) ProtoMessage 

func (*GetExemplarResponse) ProtoMessage()

func (*GetExemplarResponse) Reset 

func (m *GetExemplarResponse) Reset()

func (*GetExemplarResponse) String 

func (m *GetExemplarResponse) String() string

func (*GetExemplarResponse) XXX_DiscardUnknown 

func (m *GetExemplarResponse) XXX_DiscardUnknown()

func (*GetExemplarResponse) XXX_Marshal 

func (m *GetExemplarResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetExemplarResponse) XXX_Merge 

func (m *GetExemplarResponse) XXX_Merge(src proto.Message)

func (*GetExemplarResponse) XXX_Size 

func (m *GetExemplarResponse) XXX_Size() int

func (*GetExemplarResponse) XXX_Unmarshal 

func (m *GetExemplarResponse) XXX_Unmarshal(b []byte) error

type GetPdfPageRequest 

type GetPdfPageRequest struct {
	// The name of the PDF to get.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The page number to get (first page is 1).
	PageNumber           int32    `protobuf:"varint,2,opt,name=page_number,json=pageNumber,proto3" json:"page_number,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GetPdfPageRequest) Descriptor 

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

func (*GetPdfPageRequest) GetName 

func (m *GetPdfPageRequest) GetName() string

func (*GetPdfPageRequest) GetPageNumber 

func (m *GetPdfPageRequest) GetPageNumber() int32

func (*GetPdfPageRequest) ProtoMessage 

func (*GetPdfPageRequest) ProtoMessage()

func (*GetPdfPageRequest) Reset 

func (m *GetPdfPageRequest) Reset()

func (*GetPdfPageRequest) String 

func (m *GetPdfPageRequest) String() string

func (*GetPdfPageRequest) XXX_DiscardUnknown 

func (m *GetPdfPageRequest) XXX_DiscardUnknown()

func (*GetPdfPageRequest) XXX_Marshal 

func (m *GetPdfPageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetPdfPageRequest) XXX_Merge 

func (m *GetPdfPageRequest) XXX_Merge(src proto.Message)

func (*GetPdfPageRequest) XXX_Size 

func (m *GetPdfPageRequest) XXX_Size() int

func (*GetPdfPageRequest) XXX_Unmarshal 

func (m *GetPdfPageRequest) XXX_Unmarshal(b []byte) error

type GetPdfPageResponse 

type GetPdfPageResponse struct {
	// The returned page.
	Page                 *ntypes.PdfPage `protobuf:"bytes,1,opt,name=page,proto3" json:"page,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*GetPdfPageResponse) Descriptor 

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

func (*GetPdfPageResponse) GetPage 

func (m *GetPdfPageResponse) GetPage() *ntypes.PdfPage

func (*GetPdfPageResponse) ProtoMessage 

func (*GetPdfPageResponse) ProtoMessage()

func (*GetPdfPageResponse) Reset 

func (m *GetPdfPageResponse) Reset()

func (*GetPdfPageResponse) String 

func (m *GetPdfPageResponse) String() string

func (*GetPdfPageResponse) XXX_DiscardUnknown 

func (m *GetPdfPageResponse) XXX_DiscardUnknown()

func (*GetPdfPageResponse) XXX_Marshal 

func (m *GetPdfPageResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetPdfPageResponse) XXX_Merge 

func (m *GetPdfPageResponse) XXX_Merge(src proto.Message)

func (*GetPdfPageResponse) XXX_Size 

func (m *GetPdfPageResponse) XXX_Size() int

func (*GetPdfPageResponse) XXX_Unmarshal 

func (m *GetPdfPageResponse) XXX_Unmarshal(b []byte) error

type ListExemplarsRequest 

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

func (*ListExemplarsRequest) Descriptor 

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

func (*ListExemplarsRequest) ProtoMessage 

func (*ListExemplarsRequest) ProtoMessage()

func (*ListExemplarsRequest) Reset 

func (m *ListExemplarsRequest) Reset()

func (*ListExemplarsRequest) String 

func (m *ListExemplarsRequest) String() string

func (*ListExemplarsRequest) XXX_DiscardUnknown 

func (m *ListExemplarsRequest) XXX_DiscardUnknown()

func (*ListExemplarsRequest) XXX_Marshal 

func (m *ListExemplarsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListExemplarsRequest) XXX_Merge 

func (m *ListExemplarsRequest) XXX_Merge(src proto.Message)

func (*ListExemplarsRequest) XXX_Size 

func (m *ListExemplarsRequest) XXX_Size() int

func (*ListExemplarsRequest) XXX_Unmarshal 

func (m *ListExemplarsRequest) XXX_Unmarshal(b []byte) error

type ListExemplarsResponse 

type ListExemplarsResponse struct {
	// The returned exemplars do not include the image data.
	Exemplars            []*ntypes.Exemplar `protobuf:"bytes,1,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

func (*ListExemplarsResponse) Descriptor 

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

func (*ListExemplarsResponse) GetExemplars 

func (m *ListExemplarsResponse) GetExemplars() []*ntypes.Exemplar

func (*ListExemplarsResponse) ProtoMessage 

func (*ListExemplarsResponse) ProtoMessage()

func (*ListExemplarsResponse) Reset 

func (m *ListExemplarsResponse) Reset()

func (*ListExemplarsResponse) String 

func (m *ListExemplarsResponse) String() string

func (*ListExemplarsResponse) XXX_DiscardUnknown 

func (m *ListExemplarsResponse) XXX_DiscardUnknown()

func (*ListExemplarsResponse) XXX_Marshal 

func (m *ListExemplarsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListExemplarsResponse) XXX_Merge 

func (m *ListExemplarsResponse) XXX_Merge(src proto.Message)

func (*ListExemplarsResponse) XXX_Size 

func (m *ListExemplarsResponse) XXX_Size() int

func (*ListExemplarsResponse) XXX_Unmarshal 

func (m *ListExemplarsResponse) XXX_Unmarshal(b []byte) error

type ListFieldsRequest 

type ListFieldsRequest struct {
	// The identifier for the exemplar that the fields of interest are in.
	ExemplarName         string   `protobuf:"bytes,1,opt,name=exemplar_name,json=exemplarName,proto3" json:"exemplar_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ListFieldsRequest) Descriptor 

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

func (*ListFieldsRequest) GetExemplarName 

func (m *ListFieldsRequest) GetExemplarName() string

func (*ListFieldsRequest) ProtoMessage 

func (*ListFieldsRequest) ProtoMessage()

func (*ListFieldsRequest) Reset 

func (m *ListFieldsRequest) Reset()

func (*ListFieldsRequest) String 

func (m *ListFieldsRequest) String() string

func (*ListFieldsRequest) XXX_DiscardUnknown 

func (m *ListFieldsRequest) XXX_DiscardUnknown()

func (*ListFieldsRequest) XXX_Marshal 

func (m *ListFieldsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListFieldsRequest) XXX_Merge 

func (m *ListFieldsRequest) XXX_Merge(src proto.Message)

func (*ListFieldsRequest) XXX_Size 

func (m *ListFieldsRequest) XXX_Size() int

func (*ListFieldsRequest) XXX_Unmarshal 

func (m *ListFieldsRequest) XXX_Unmarshal(b []byte) error

type ListFieldsResponse 

type ListFieldsResponse struct {
	Fields               []*ntypes.Field `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*ListFieldsResponse) Descriptor 

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

func (*ListFieldsResponse) GetFields 

func (m *ListFieldsResponse) GetFields() []*ntypes.Field

func (*ListFieldsResponse) ProtoMessage 

func (*ListFieldsResponse) ProtoMessage()

func (*ListFieldsResponse) Reset 

func (m *ListFieldsResponse) Reset()

func (*ListFieldsResponse) String 

func (m *ListFieldsResponse) String() string

func (*ListFieldsResponse) XXX_DiscardUnknown 

func (m *ListFieldsResponse) XXX_DiscardUnknown()

func (*ListFieldsResponse) XXX_Marshal 

func (m *ListFieldsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListFieldsResponse) XXX_Merge 

func (m *ListFieldsResponse) XXX_Merge(src proto.Message)

func (*ListFieldsResponse) XXX_Size 

func (m *ListFieldsResponse) XXX_Size() int

func (*ListFieldsResponse) XXX_Unmarshal 

func (m *ListFieldsResponse) XXX_Unmarshal(b []byte) error

type UnimplementedExemplarsServer 

type UnimplementedExemplarsServer struct {
}

UnimplementedExemplarsServer can be embedded to have forward compatible implementations.

func (*UnimplementedExemplarsServer) CreateExemplar 

func (*UnimplementedExemplarsServer) CreateExemplar(ctx context.Context, req *CreateExemplarRequest) (*CreateExemplarResponse, error)

func (*UnimplementedExemplarsServer) CreateExemplarLRO 

func (*UnimplementedExemplarsServer) CreateExemplarLRO(ctx context.Context, req *CreateExemplarRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) CreateField 

func (*UnimplementedExemplarsServer) CreateField(ctx context.Context, req *CreateFieldRequest) (*CreateFieldResponse, error)

func (*UnimplementedExemplarsServer) CreateFieldLRO 

func (*UnimplementedExemplarsServer) CreateFieldLRO(ctx context.Context, req *CreateFieldRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) DeleteExemplar 

func (*UnimplementedExemplarsServer) DeleteExemplar(ctx context.Context, req *DeleteExemplarRequest) (*empty.Empty, error)

func (*UnimplementedExemplarsServer) DeleteExemplarLRO 

func (*UnimplementedExemplarsServer) DeleteExemplarLRO(ctx context.Context, req *DeleteExemplarRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) DeleteField 

func (*UnimplementedExemplarsServer) DeleteField(ctx context.Context, req *DeleteFieldRequest) (*empty.Empty, error)

func (*UnimplementedExemplarsServer) DeleteFieldLRO 

func (*UnimplementedExemplarsServer) DeleteFieldLRO(ctx context.Context, req *DeleteFieldRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) GetExemplar 

func (*UnimplementedExemplarsServer) GetExemplar(ctx context.Context, req *GetExemplarRequest) (*GetExemplarResponse, error)

func (*UnimplementedExemplarsServer) GetExemplarLRO 

func (*UnimplementedExemplarsServer) GetExemplarLRO(ctx context.Context, req *GetExemplarRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) GetPdfPage 

func (*UnimplementedExemplarsServer) GetPdfPage(ctx context.Context, req *GetPdfPageRequest) (*GetPdfPageResponse, error)

func (*UnimplementedExemplarsServer) GetPdfPageLRO 

func (*UnimplementedExemplarsServer) GetPdfPageLRO(ctx context.Context, req *GetPdfPageRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) ListExemplars 

func (*UnimplementedExemplarsServer) ListExemplars(ctx context.Context, req *ListExemplarsRequest) (*ListExemplarsResponse, error)

func (*UnimplementedExemplarsServer) ListExemplarsLRO 

func (*UnimplementedExemplarsServer) ListExemplarsLRO(ctx context.Context, req *ListExemplarsRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) ListFields 

func (*UnimplementedExemplarsServer) ListFields(ctx context.Context, req *ListFieldsRequest) (*ListFieldsResponse, error)

func (*UnimplementedExemplarsServer) ListFieldsLRO 

func (*UnimplementedExemplarsServer) ListFieldsLRO(ctx context.Context, req *ListFieldsRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) UploadDimensionedImage 

func (*UnimplementedExemplarsServer) UploadDimensionedImage(ctx context.Context, req *UploadDimensionedImageRequest) (*UploadDimensionedImageResponse, error)

func (*UnimplementedExemplarsServer) UploadDimensionedImageLRO 

func (*UnimplementedExemplarsServer) UploadDimensionedImageLRO(ctx context.Context, req *UploadDimensionedImageRequest) (*longrunning.Operation, error)

func (*UnimplementedExemplarsServer) UploadPdf 

func (*UnimplementedExemplarsServer) UploadPdf(ctx context.Context, req *UploadPdfRequest) (*UploadPdfResponse, error)

func (*UnimplementedExemplarsServer) UploadPdfLRO 

func (*UnimplementedExemplarsServer) UploadPdfLRO(ctx context.Context, req *UploadPdfRequest) (*longrunning.Operation, error)

type UploadDimensionedImageRequest 

type UploadDimensionedImageRequest struct {
	// Ideally, this image started as a page in a native PDF and was exported by Acrobat
	// or equiv as an exact image of what is printed. If instead it is based on a scan of
	// a printed form, make sure the fully deskewed and is as clean as possible.
	Name                 string                   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Image                *ntypes.DimensionedImage `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                 `json:"-"`
	XXX_unrecognized     []byte                   `json:"-"`
	XXX_sizecache        int32                    `json:"-"`
}

func (*UploadDimensionedImageRequest) Descriptor 

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

func (*UploadDimensionedImageRequest) GetImage 

func (m *UploadDimensionedImageRequest) GetImage() *ntypes.DimensionedImage

func (*UploadDimensionedImageRequest) GetName 

func (m *UploadDimensionedImageRequest) GetName() string

func (*UploadDimensionedImageRequest) ProtoMessage 

func (*UploadDimensionedImageRequest) ProtoMessage()

func (*UploadDimensionedImageRequest) Reset 

func (m *UploadDimensionedImageRequest) Reset()

func (*UploadDimensionedImageRequest) String 

func (m *UploadDimensionedImageRequest) String() string

func (*UploadDimensionedImageRequest) XXX_DiscardUnknown 

func (m *UploadDimensionedImageRequest) XXX_DiscardUnknown()

func (*UploadDimensionedImageRequest) XXX_Marshal 

func (m *UploadDimensionedImageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UploadDimensionedImageRequest) XXX_Merge 

func (m *UploadDimensionedImageRequest) XXX_Merge(src proto.Message)

func (*UploadDimensionedImageRequest) XXX_Size 

func (m *UploadDimensionedImageRequest) XXX_Size() int

func (*UploadDimensionedImageRequest) XXX_Unmarshal 

func (m *UploadDimensionedImageRequest) XXX_Unmarshal(b []byte) error

type UploadDimensionedImageResponse 

type UploadDimensionedImageResponse struct {
	// The supplied or generated name the uploaded dimensioned image.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The expiration time of the image. If the image has not been registered
	// as an exemplar prior to this time, it is forgotten. However, once an image
	// has been registered, it becomes a permanent part of the exemplar.
	ExpireTime           *timestamp.Timestamp `protobuf:"bytes,2,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

func (*UploadDimensionedImageResponse) Descriptor 

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

func (*UploadDimensionedImageResponse) GetExpireTime 

func (m *UploadDimensionedImageResponse) GetExpireTime() *timestamp.Timestamp

func (*UploadDimensionedImageResponse) GetName 

func (m *UploadDimensionedImageResponse) GetName() string

func (*UploadDimensionedImageResponse) ProtoMessage 

func (*UploadDimensionedImageResponse) ProtoMessage()

func (*UploadDimensionedImageResponse) Reset 

func (m *UploadDimensionedImageResponse) Reset()

func (*UploadDimensionedImageResponse) String 

func (m *UploadDimensionedImageResponse) String() string

func (*UploadDimensionedImageResponse) XXX_DiscardUnknown 

func (m *UploadDimensionedImageResponse) XXX_DiscardUnknown()

func (*UploadDimensionedImageResponse) XXX_Marshal 

func (m *UploadDimensionedImageResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UploadDimensionedImageResponse) XXX_Merge 

func (m *UploadDimensionedImageResponse) XXX_Merge(src proto.Message)

func (*UploadDimensionedImageResponse) XXX_Size 

func (m *UploadDimensionedImageResponse) XXX_Size() int

func (*UploadDimensionedImageResponse) XXX_Unmarshal 

func (m *UploadDimensionedImageResponse) XXX_Unmarshal(b []byte) error

type UploadPdfRequest 

type UploadPdfRequest struct {
	// Client-assigned identifier for the PDF file being uploaded. Must match the
	// regex '^[0-9A-Za-z.-]{1,48}$' and must not collide with other unexpired PDFs.
	// If not supplied, a satisfactory name is automatically generated.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Only the page numbers listed here will be rendered and made available for
	// later registration as a form exemplar. If no pages are listed, all pages will
	// be rendered and be made available.  The first page is page 1, not page 0.
	PageNumbers []int32 `protobuf:"varint,2,rep,packed,name=page_numbers,json=pageNumbers,proto3" json:"page_numbers,omitempty"`
	// The actual PDF data.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// The dominant language of the pdf.
	Language             ntypes.Language `protobuf:"varint,4,opt,name=language,proto3,enum=nsys.api.ntypes.Language" json:"language,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*UploadPdfRequest) Descriptor 

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

func (*UploadPdfRequest) GetData 

func (m *UploadPdfRequest) GetData() []byte

func (*UploadPdfRequest) GetLanguage 

func (m *UploadPdfRequest) GetLanguage() ntypes.Language

func (*UploadPdfRequest) GetName 

func (m *UploadPdfRequest) GetName() string

func (*UploadPdfRequest) GetPageNumbers 

func (m *UploadPdfRequest) GetPageNumbers() []int32

func (*UploadPdfRequest) ProtoMessage 

func (*UploadPdfRequest) ProtoMessage()

func (*UploadPdfRequest) Reset 

func (m *UploadPdfRequest) Reset()

func (*UploadPdfRequest) String 

func (m *UploadPdfRequest) String() string

func (*UploadPdfRequest) XXX_DiscardUnknown 

func (m *UploadPdfRequest) XXX_DiscardUnknown()

func (*UploadPdfRequest) XXX_Marshal 

func (m *UploadPdfRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UploadPdfRequest) XXX_Merge 

func (m *UploadPdfRequest) XXX_Merge(src proto.Message)

func (*UploadPdfRequest) XXX_Size 

func (m *UploadPdfRequest) XXX_Size() int

func (*UploadPdfRequest) XXX_Unmarshal 

func (m *UploadPdfRequest) XXX_Unmarshal(b []byte) error

type UploadPdfResponse 

type UploadPdfResponse struct {
	// The specified or generated name for the PDF.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Info on all of the processed pages. Guaranteed to be in increasing page order.
	// The returned pages do NOT include the image data.
	ProcessedPages []*ntypes.PdfPage `protobuf:"bytes,2,rep,name=processed_pages,json=processedPages,proto3" json:"processed_pages,omitempty"`
	// The expiration time of the PDF. If pages from the PDF have not been registered
	// as an exemplar prior to this time, they are forgotten. However, once a page
	// has been registered, it becomes a permanent part of the exemplar.
	ExpireTime           *timestamp.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

func (*UploadPdfResponse) Descriptor 

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

func (*UploadPdfResponse) GetExpireTime 

func (m *UploadPdfResponse) GetExpireTime() *timestamp.Timestamp

func (*UploadPdfResponse) GetName 

func (m *UploadPdfResponse) GetName() string

func (*UploadPdfResponse) GetProcessedPages 

func (m *UploadPdfResponse) GetProcessedPages() []*ntypes.PdfPage

func (*UploadPdfResponse) ProtoMessage 

func (*UploadPdfResponse) ProtoMessage()

func (*UploadPdfResponse) Reset 

func (m *UploadPdfResponse) Reset()

func (*UploadPdfResponse) String 

func (m *UploadPdfResponse) String() string

func (*UploadPdfResponse) XXX_DiscardUnknown 

func (m *UploadPdfResponse) XXX_DiscardUnknown()

func (*UploadPdfResponse) XXX_Marshal 

func (m *UploadPdfResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UploadPdfResponse) XXX_Merge 

func (m *UploadPdfResponse) XXX_Merge(src proto.Message)

func (*UploadPdfResponse) XXX_Size 

func (m *UploadPdfResponse) XXX_Size() int

func (*UploadPdfResponse) XXX_Unmarshal 

func (m *UploadPdfResponse) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

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