file

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

View Source
var RenderPdfGSResponse_Error_name = map[int32]string{
	0: "SUCCESS",
	1: "ENCRYPTED",
	2: "CORRUPTED",
	3: "NOT_PERMITTED",
}
View Source
var RenderPdfGSResponse_Error_value = map[string]int32{
	"SUCCESS":       0,
	"ENCRYPTED":     1,
	"CORRUPTED":     2,
	"NOT_PERMITTED": 3,
}
View Source
var RenderPdfResponse_Error_name = map[int32]string{
	0: "SUCCESS",
	1: "ENCRYPTED",
	2: "CORRUPTED",
	3: "NOT_PERMITTED",
}
View Source
var RenderPdfResponse_Error_value = map[string]int32{
	"SUCCESS":       0,
	"ENCRYPTED":     1,
	"CORRUPTED":     2,
	"NOT_PERMITTED": 3,
}
View Source
var SplitTiffResponse_Error_name = map[int32]string{
	0: "SUCCESS",
	1: "CORRUPTED",
}
View Source
var SplitTiffResponse_Error_value = map[string]int32{
	"SUCCESS":   0,
	"CORRUPTED": 1,
}

Functions

func RegisterFileProcessingServer

func RegisterFileProcessingServer(s *grpc.Server, srv FileProcessingServer)

Types

type AvailableResult

type AvailableResult struct {
	// The object's name / ID.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Application-specific meta information.
	Metadata             *any.Any `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AvailableResult) Descriptor

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

func (*AvailableResult) GetMetadata

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

func (*AvailableResult) GetName

func (m *AvailableResult) GetName() string

func (*AvailableResult) ProtoMessage

func (*AvailableResult) ProtoMessage()

func (*AvailableResult) Reset

func (m *AvailableResult) Reset()

func (*AvailableResult) String

func (m *AvailableResult) String() string

func (*AvailableResult) XXX_DiscardUnknown

func (m *AvailableResult) XXX_DiscardUnknown()

func (*AvailableResult) XXX_Marshal

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

func (*AvailableResult) XXX_Merge

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

func (*AvailableResult) XXX_Size

func (m *AvailableResult) XXX_Size() int

func (*AvailableResult) XXX_Unmarshal

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

type CreateFilesetRequest

type CreateFilesetRequest struct {
	// The fileset's identifier which must be unique within the
	// account and must match the regex '^[0-9A-Za-z.-]{1,48}$'.
	// Automatically generated if not supplied.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// One or more files that are to become members of the fileset.
	FileNames []string `protobuf:"bytes,2,rep,name=file_names,json=fileNames,proto3" json:"file_names,omitempty"`
	// Requested fileset expiration time. The time is capped so that it
	// is no later than the latest expiration time of any file in the set.
	// A zero value requests the maximum allowable expiration time be used.
	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 (*CreateFilesetRequest) Descriptor

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

func (*CreateFilesetRequest) GetExpireTime

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

func (*CreateFilesetRequest) GetFileNames

func (m *CreateFilesetRequest) GetFileNames() []string

func (*CreateFilesetRequest) GetName

func (m *CreateFilesetRequest) GetName() string

func (*CreateFilesetRequest) ProtoMessage

func (*CreateFilesetRequest) ProtoMessage()

func (*CreateFilesetRequest) Reset

func (m *CreateFilesetRequest) Reset()

func (*CreateFilesetRequest) String

func (m *CreateFilesetRequest) String() string

func (*CreateFilesetRequest) XXX_DiscardUnknown

func (m *CreateFilesetRequest) XXX_DiscardUnknown()

func (*CreateFilesetRequest) XXX_Marshal

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

func (*CreateFilesetRequest) XXX_Merge

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

func (*CreateFilesetRequest) XXX_Size

func (m *CreateFilesetRequest) XXX_Size() int

func (*CreateFilesetRequest) XXX_Unmarshal

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

type CreateFilesetResponse

type CreateFilesetResponse struct {
	// Identifier for the fileset.
	Name string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	// The actual expiration time for the fileset.
	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 (*CreateFilesetResponse) Descriptor

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

func (*CreateFilesetResponse) GetExpireTime

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

func (*CreateFilesetResponse) GetName

func (m *CreateFilesetResponse) GetName() string

func (*CreateFilesetResponse) ProtoMessage

func (*CreateFilesetResponse) ProtoMessage()

func (*CreateFilesetResponse) Reset

func (m *CreateFilesetResponse) Reset()

func (*CreateFilesetResponse) String

func (m *CreateFilesetResponse) String() string

func (*CreateFilesetResponse) XXX_DiscardUnknown

func (m *CreateFilesetResponse) XXX_DiscardUnknown()

func (*CreateFilesetResponse) XXX_Marshal

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

func (*CreateFilesetResponse) XXX_Merge

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

func (*CreateFilesetResponse) XXX_Size

func (m *CreateFilesetResponse) XXX_Size() int

func (*CreateFilesetResponse) XXX_Unmarshal

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

type DeleteResultRequest

type DeleteResultRequest struct {
	// The available result 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 (*DeleteResultRequest) Descriptor

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

func (*DeleteResultRequest) GetName

func (m *DeleteResultRequest) GetName() string

func (*DeleteResultRequest) ProtoMessage

func (*DeleteResultRequest) ProtoMessage()

func (*DeleteResultRequest) Reset

func (m *DeleteResultRequest) Reset()

func (*DeleteResultRequest) String

func (m *DeleteResultRequest) String() string

func (*DeleteResultRequest) XXX_DiscardUnknown

func (m *DeleteResultRequest) XXX_DiscardUnknown()

func (*DeleteResultRequest) XXX_Marshal

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

func (*DeleteResultRequest) XXX_Merge

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

func (*DeleteResultRequest) XXX_Size

func (m *DeleteResultRequest) XXX_Size() int

func (*DeleteResultRequest) XXX_Unmarshal

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

type DocToPdfRequest

type DocToPdfRequest struct {
	// The generic file id of the document to be rendered.
	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 (*DocToPdfRequest) Descriptor

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

func (*DocToPdfRequest) GetName

func (m *DocToPdfRequest) GetName() string

func (*DocToPdfRequest) ProtoMessage

func (*DocToPdfRequest) ProtoMessage()

func (*DocToPdfRequest) Reset

func (m *DocToPdfRequest) Reset()

func (*DocToPdfRequest) String

func (m *DocToPdfRequest) String() string

func (*DocToPdfRequest) XXX_DiscardUnknown

func (m *DocToPdfRequest) XXX_DiscardUnknown()

func (*DocToPdfRequest) XXX_Marshal

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

func (*DocToPdfRequest) XXX_Merge

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

func (*DocToPdfRequest) XXX_Size

func (m *DocToPdfRequest) XXX_Size() int

func (*DocToPdfRequest) XXX_Unmarshal

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

type DocToPdfResponse

type DocToPdfResponse struct {
	// the generic file id of the rendered pdf.
	PdfName              string   `protobuf:"bytes,1,opt,name=pdf_name,json=pdfName,proto3" json:"pdf_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*DocToPdfResponse) Descriptor

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

func (*DocToPdfResponse) GetPdfName

func (m *DocToPdfResponse) GetPdfName() string

func (*DocToPdfResponse) ProtoMessage

func (*DocToPdfResponse) ProtoMessage()

func (*DocToPdfResponse) Reset

func (m *DocToPdfResponse) Reset()

func (*DocToPdfResponse) String

func (m *DocToPdfResponse) String() string

func (*DocToPdfResponse) XXX_DiscardUnknown

func (m *DocToPdfResponse) XXX_DiscardUnknown()

func (*DocToPdfResponse) XXX_Marshal

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

func (*DocToPdfResponse) XXX_Merge

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

func (*DocToPdfResponse) XXX_Size

func (m *DocToPdfResponse) XXX_Size() int

func (*DocToPdfResponse) XXX_Unmarshal

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

type FileProcessingClient

type FileProcessingClient interface {
	// Upload a generic file for further processing later.
	UploadGenericFile(ctx context.Context, in *UploadGenericFileRequest, opts ...grpc.CallOption) (*UploadGenericFileResponse, error)
	UploadGenericFileLRO(ctx context.Context, in *UploadGenericFileRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Download a previously uploaded generic file.
	GetGenericFile(ctx context.Context, in *GetGenericFileRequest, opts ...grpc.CallOption) (*GetGenericFileResponse, error)
	GetGenericFileLRO(ctx context.Context, in *GetGenericFileRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Group any number of previously-uploaded files together into a
	// single fileset. Files may have membership in multiple filesets.
	CreateFileset(ctx context.Context, in *CreateFilesetRequest, opts ...grpc.CallOption) (*CreateFilesetResponse, error)
	CreateFilesetLRO(ctx context.Context, in *CreateFilesetRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Begin processing a file or fileset in the specified way.
	// This is a temporary hack (therefore this will be here forever ;-)
	// The results of the processing are obtained by polling for them
	// using the ListResults() RPC and fetching via GetResult().
	InitiateProcessing(ctx context.Context, in *InitiateProcessingRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	InitiateProcessingLRO(ctx context.Context, in *InitiateProcessingRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Given a document (.doc, .docx, .txt, .ppt, ect.) convert it to pdf
	DocToPdf(ctx context.Context, in *DocToPdfRequest, opts ...grpc.CallOption) (*DocToPdfResponse, error)
	DocToPdfLRO(ctx context.Context, in *DocToPdfRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Parses an email *.eml file stored as a generic file. Stores all
	// attachments as new generic files and returns the email headers, body,
	// and list of attachments.
	ParseEmail(ctx context.Context, in *ParseEmailRequest, opts ...grpc.CallOption) (*ParseEmailResponse, error)
	ParseEmailLRO(ctx context.Context, in *ParseEmailRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Given an email *.eml file stored as a generic file, this renders the
	// email body as a pdf and stores the pdf as a new generic file.
	RenderEmailBody(ctx context.Context, in *RenderEmailBodyRequest, opts ...grpc.CallOption) (*RenderEmailBodyResponse, error)
	RenderEmailBodyLRO(ctx context.Context, in *RenderEmailBodyRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Using Adobe, given a pdf file stored as a generic file, this renders the
	// individual pages of the pdf as image files and stores them as new generic
	// files.
	RenderPdf(ctx context.Context, in *RenderPdfRequest, opts ...grpc.CallOption) (*RenderPdfResponse, error)
	RenderPdfLRO(ctx context.Context, in *RenderPdfRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Using Ghostscript, given a pdf file stored as a generic file, this
	// renders the individual pages of the pdf as image files and stores them as
	// new generic files.
	RenderPdfGS(ctx context.Context, in *RenderPdfGSRequest, opts ...grpc.CallOption) (*RenderPdfGSResponse, error)
	RenderPdfGSLRO(ctx context.Context, in *RenderPdfGSRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Given a tiff file stored as a generic file, this splits the pages into
	// individual png files and stores them as new generic files.
	SplitTiff(ctx context.Context, in *SplitTiffRequest, opts ...grpc.CallOption) (*SplitTiffResponse, error)
	SplitTiffLRO(ctx context.Context, in *SplitTiffRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Returns a list of available processed results (i.e., the final outputs
	// of the client/application-specific operations triggered by InitiateProcessing()
	ListResults(ctx context.Context, in *ListResultsRequest, opts ...grpc.CallOption) (*ListResultsResponse, error)
	ListResultsLRO(ctx context.Context, in *ListResultsRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Fetch any available result.
	GetResult(ctx context.Context, in *GetResultRequest, opts ...grpc.CallOption) (*GetResultResponse, error)
	GetResultLRO(ctx context.Context, in *GetResultRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Delete any available result.
	DeleteResult(ctx context.Context, in *DeleteResultRequest, opts ...grpc.CallOption) (*empty.Empty, error)
	DeleteResultLRO(ctx context.Context, in *DeleteResultRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
}

FileProcessingClient is the client API for FileProcessing service.

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

func NewFileProcessingClient

func NewFileProcessingClient(cc *grpc.ClientConn) FileProcessingClient

type FileProcessingServer

type FileProcessingServer interface {
	// Upload a generic file for further processing later.
	UploadGenericFile(context.Context, *UploadGenericFileRequest) (*UploadGenericFileResponse, error)
	UploadGenericFileLRO(context.Context, *UploadGenericFileRequest) (*longrunning.Operation, error)
	// Download a previously uploaded generic file.
	GetGenericFile(context.Context, *GetGenericFileRequest) (*GetGenericFileResponse, error)
	GetGenericFileLRO(context.Context, *GetGenericFileRequest) (*longrunning.Operation, error)
	// Group any number of previously-uploaded files together into a
	// single fileset. Files may have membership in multiple filesets.
	CreateFileset(context.Context, *CreateFilesetRequest) (*CreateFilesetResponse, error)
	CreateFilesetLRO(context.Context, *CreateFilesetRequest) (*longrunning.Operation, error)
	// Begin processing a file or fileset in the specified way.
	// This is a temporary hack (therefore this will be here forever ;-)
	// The results of the processing are obtained by polling for them
	// using the ListResults() RPC and fetching via GetResult().
	InitiateProcessing(context.Context, *InitiateProcessingRequest) (*empty.Empty, error)
	InitiateProcessingLRO(context.Context, *InitiateProcessingRequest) (*longrunning.Operation, error)
	// Given a document (.doc, .docx, .txt, .ppt, ect.) convert it to pdf
	DocToPdf(context.Context, *DocToPdfRequest) (*DocToPdfResponse, error)
	DocToPdfLRO(context.Context, *DocToPdfRequest) (*longrunning.Operation, error)
	// Parses an email *.eml file stored as a generic file. Stores all
	// attachments as new generic files and returns the email headers, body,
	// and list of attachments.
	ParseEmail(context.Context, *ParseEmailRequest) (*ParseEmailResponse, error)
	ParseEmailLRO(context.Context, *ParseEmailRequest) (*longrunning.Operation, error)
	// Given an email *.eml file stored as a generic file, this renders the
	// email body as a pdf and stores the pdf as a new generic file.
	RenderEmailBody(context.Context, *RenderEmailBodyRequest) (*RenderEmailBodyResponse, error)
	RenderEmailBodyLRO(context.Context, *RenderEmailBodyRequest) (*longrunning.Operation, error)
	// Using Adobe, given a pdf file stored as a generic file, this renders the
	// individual pages of the pdf as image files and stores them as new generic
	// files.
	RenderPdf(context.Context, *RenderPdfRequest) (*RenderPdfResponse, error)
	RenderPdfLRO(context.Context, *RenderPdfRequest) (*longrunning.Operation, error)
	// Using Ghostscript, given a pdf file stored as a generic file, this
	// renders the individual pages of the pdf as image files and stores them as
	// new generic files.
	RenderPdfGS(context.Context, *RenderPdfGSRequest) (*RenderPdfGSResponse, error)
	RenderPdfGSLRO(context.Context, *RenderPdfGSRequest) (*longrunning.Operation, error)
	// Given a tiff file stored as a generic file, this splits the pages into
	// individual png files and stores them as new generic files.
	SplitTiff(context.Context, *SplitTiffRequest) (*SplitTiffResponse, error)
	SplitTiffLRO(context.Context, *SplitTiffRequest) (*longrunning.Operation, error)
	// Returns a list of available processed results (i.e., the final outputs
	// of the client/application-specific operations triggered by InitiateProcessing()
	ListResults(context.Context, *ListResultsRequest) (*ListResultsResponse, error)
	ListResultsLRO(context.Context, *ListResultsRequest) (*longrunning.Operation, error)
	// Fetch any available result.
	GetResult(context.Context, *GetResultRequest) (*GetResultResponse, error)
	GetResultLRO(context.Context, *GetResultRequest) (*longrunning.Operation, error)
	// Delete any available result.
	DeleteResult(context.Context, *DeleteResultRequest) (*empty.Empty, error)
	DeleteResultLRO(context.Context, *DeleteResultRequest) (*longrunning.Operation, error)
}

FileProcessingServer is the server API for FileProcessing service.

type GetGenericFileRequest

type GetGenericFileRequest struct {
	// The generic file's identifier.
	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 (*GetGenericFileRequest) Descriptor

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

func (*GetGenericFileRequest) GetName

func (m *GetGenericFileRequest) GetName() string

func (*GetGenericFileRequest) ProtoMessage

func (*GetGenericFileRequest) ProtoMessage()

func (*GetGenericFileRequest) Reset

func (m *GetGenericFileRequest) Reset()

func (*GetGenericFileRequest) String

func (m *GetGenericFileRequest) String() string

func (*GetGenericFileRequest) XXX_DiscardUnknown

func (m *GetGenericFileRequest) XXX_DiscardUnknown()

func (*GetGenericFileRequest) XXX_Marshal

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

func (*GetGenericFileRequest) XXX_Merge

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

func (*GetGenericFileRequest) XXX_Size

func (m *GetGenericFileRequest) XXX_Size() int

func (*GetGenericFileRequest) XXX_Unmarshal

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

type GetGenericFileResponse

type GetGenericFileResponse struct {
	// The file's identifier.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The actual file (SHA sum validated on the server side at read).
	GenericFile          *ntypes.GenericFile `protobuf:"bytes,2,opt,name=generic_file,json=genericFile,proto3" json:"generic_file,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

func (*GetGenericFileResponse) Descriptor

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

func (*GetGenericFileResponse) GetGenericFile

func (m *GetGenericFileResponse) GetGenericFile() *ntypes.GenericFile

func (*GetGenericFileResponse) GetName

func (m *GetGenericFileResponse) GetName() string

func (*GetGenericFileResponse) ProtoMessage

func (*GetGenericFileResponse) ProtoMessage()

func (*GetGenericFileResponse) Reset

func (m *GetGenericFileResponse) Reset()

func (*GetGenericFileResponse) String

func (m *GetGenericFileResponse) String() string

func (*GetGenericFileResponse) XXX_DiscardUnknown

func (m *GetGenericFileResponse) XXX_DiscardUnknown()

func (*GetGenericFileResponse) XXX_Marshal

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

func (*GetGenericFileResponse) XXX_Merge

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

func (*GetGenericFileResponse) XXX_Size

func (m *GetGenericFileResponse) XXX_Size() int

func (*GetGenericFileResponse) XXX_Unmarshal

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

type GetResultRequest

type GetResultRequest struct {
	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 (*GetResultRequest) Descriptor

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

func (*GetResultRequest) GetName

func (m *GetResultRequest) GetName() string

func (*GetResultRequest) ProtoMessage

func (*GetResultRequest) ProtoMessage()

func (*GetResultRequest) Reset

func (m *GetResultRequest) Reset()

func (*GetResultRequest) String

func (m *GetResultRequest) String() string

func (*GetResultRequest) XXX_DiscardUnknown

func (m *GetResultRequest) XXX_DiscardUnknown()

func (*GetResultRequest) XXX_Marshal

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

func (*GetResultRequest) XXX_Merge

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

func (*GetResultRequest) XXX_Size

func (m *GetResultRequest) XXX_Size() int

func (*GetResultRequest) XXX_Unmarshal

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

type GetResultResponse

type GetResultResponse struct {
	// The result's ID.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The originating submission (the one specified to InitiateProcessing() which then
	// caused this result (and perhaps others) to be generated.
	OriginatingName string `protobuf:"bytes,2,opt,name=originating_name,json=originatingName,proto3" json:"originating_name,omitempty"`
	// Application-specific metadata (identical to that returned in results listings).
	Metadata *any.Any `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Contents of the returned file are application-specific.
	// The metadata within it does not necessarily have any relation to the metadata above.
	GenericFile          *ntypes.GenericFile `protobuf:"bytes,4,opt,name=generic_file,json=genericFile,proto3" json:"generic_file,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

func (*GetResultResponse) Descriptor

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

func (*GetResultResponse) GetGenericFile

func (m *GetResultResponse) GetGenericFile() *ntypes.GenericFile

func (*GetResultResponse) GetMetadata

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

func (*GetResultResponse) GetName

func (m *GetResultResponse) GetName() string

func (*GetResultResponse) GetOriginatingName

func (m *GetResultResponse) GetOriginatingName() string

func (*GetResultResponse) ProtoMessage

func (*GetResultResponse) ProtoMessage()

func (*GetResultResponse) Reset

func (m *GetResultResponse) Reset()

func (*GetResultResponse) String

func (m *GetResultResponse) String() string

func (*GetResultResponse) XXX_DiscardUnknown

func (m *GetResultResponse) XXX_DiscardUnknown()

func (*GetResultResponse) XXX_Marshal

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

func (*GetResultResponse) XXX_Merge

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

func (*GetResultResponse) XXX_Size

func (m *GetResultResponse) XXX_Size() int

func (*GetResultResponse) XXX_Unmarshal

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

type InitiateProcessingRequest

type InitiateProcessingRequest struct {
	// Identifier of the object to process.
	// The context for interpretation of this identifier is set by the
	// client and application specific process code.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Application-specific type of processing to perform.
	ProcessCode          string   `protobuf:"bytes,2,opt,name=process_code,json=processCode,proto3" json:"process_code,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*InitiateProcessingRequest) Descriptor

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

func (*InitiateProcessingRequest) GetName

func (m *InitiateProcessingRequest) GetName() string

func (*InitiateProcessingRequest) GetProcessCode

func (m *InitiateProcessingRequest) GetProcessCode() string

func (*InitiateProcessingRequest) ProtoMessage

func (*InitiateProcessingRequest) ProtoMessage()

func (*InitiateProcessingRequest) Reset

func (m *InitiateProcessingRequest) Reset()

func (*InitiateProcessingRequest) String

func (m *InitiateProcessingRequest) String() string

func (*InitiateProcessingRequest) XXX_DiscardUnknown

func (m *InitiateProcessingRequest) XXX_DiscardUnknown()

func (*InitiateProcessingRequest) XXX_Marshal

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

func (*InitiateProcessingRequest) XXX_Merge

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

func (*InitiateProcessingRequest) XXX_Size

func (m *InitiateProcessingRequest) XXX_Size() int

func (*InitiateProcessingRequest) XXX_Unmarshal

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

type ListResultsRequest

type ListResultsRequest struct {
	// Application-specific filter on returned results.
	// If not specified, all result listings are returned.
	Filter               string   `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ListResultsRequest) Descriptor

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

func (*ListResultsRequest) GetFilter

func (m *ListResultsRequest) GetFilter() string

func (*ListResultsRequest) ProtoMessage

func (*ListResultsRequest) ProtoMessage()

func (*ListResultsRequest) Reset

func (m *ListResultsRequest) Reset()

func (*ListResultsRequest) String

func (m *ListResultsRequest) String() string

func (*ListResultsRequest) XXX_DiscardUnknown

func (m *ListResultsRequest) XXX_DiscardUnknown()

func (*ListResultsRequest) XXX_Marshal

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

func (*ListResultsRequest) XXX_Merge

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

func (*ListResultsRequest) XXX_Size

func (m *ListResultsRequest) XXX_Size() int

func (*ListResultsRequest) XXX_Unmarshal

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

type ListResultsResponse

type ListResultsResponse struct {
	AvailableResults     []*AvailableResult `protobuf:"bytes,1,rep,name=available_results,json=availableResults,proto3" json:"available_results,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

func (*ListResultsResponse) Descriptor

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

func (*ListResultsResponse) GetAvailableResults

func (m *ListResultsResponse) GetAvailableResults() []*AvailableResult

func (*ListResultsResponse) ProtoMessage

func (*ListResultsResponse) ProtoMessage()

func (*ListResultsResponse) Reset

func (m *ListResultsResponse) Reset()

func (*ListResultsResponse) String

func (m *ListResultsResponse) String() string

func (*ListResultsResponse) XXX_DiscardUnknown

func (m *ListResultsResponse) XXX_DiscardUnknown()

func (*ListResultsResponse) XXX_Marshal

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

func (*ListResultsResponse) XXX_Merge

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

func (*ListResultsResponse) XXX_Size

func (m *ListResultsResponse) XXX_Size() int

func (*ListResultsResponse) XXX_Unmarshal

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

type ParseEmailRequest

type ParseEmailRequest struct {
	// The name of a generic file contaning an eml file
	EmlName string `protobuf:"bytes,1,opt,name=eml_name,json=emlName,proto3" json:"eml_name,omitempty"`
	// The whitelist of email attachment file extensions to save, things like:
	// ".pdf", ".png", ".tif", ".tiff", ".jpg", ".jpeg". If empty, then no
	// attachments will be saved. In any case a list of rejected attachments
	// will be returned.
	AttachmentWhitelist []string `protobuf:"bytes,2,rep,name=attachment_whitelist,json=attachmentWhitelist,proto3" json:"attachment_whitelist,omitempty"`
	// The whitelist of inline email attachment file extensions to save. If empty,
	// then no inline attachments will be saved.
	InlineWhitelist      []string `protobuf:"bytes,3,rep,name=inline_whitelist,json=inlineWhitelist,proto3" json:"inline_whitelist,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ParseEmailRequest) Descriptor

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

func (*ParseEmailRequest) GetAttachmentWhitelist

func (m *ParseEmailRequest) GetAttachmentWhitelist() []string

func (*ParseEmailRequest) GetEmlName

func (m *ParseEmailRequest) GetEmlName() string

func (*ParseEmailRequest) GetInlineWhitelist

func (m *ParseEmailRequest) GetInlineWhitelist() []string

func (*ParseEmailRequest) ProtoMessage

func (*ParseEmailRequest) ProtoMessage()

func (*ParseEmailRequest) Reset

func (m *ParseEmailRequest) Reset()

func (*ParseEmailRequest) String

func (m *ParseEmailRequest) String() string

func (*ParseEmailRequest) XXX_DiscardUnknown

func (m *ParseEmailRequest) XXX_DiscardUnknown()

func (*ParseEmailRequest) XXX_Marshal

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

func (*ParseEmailRequest) XXX_Merge

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

func (*ParseEmailRequest) XXX_Size

func (m *ParseEmailRequest) XXX_Size() int

func (*ParseEmailRequest) XXX_Unmarshal

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

type ParseEmailResponse

type ParseEmailResponse struct {
	// The name of a generic file containing the parsed email
	ParsedEmailName string `protobuf:"bytes,1,opt,name=parsed_email_name,json=parsedEmailName,proto3" json:"parsed_email_name,omitempty"`
	// The parsed email
	ParsedEmail          *ntypes.ParsedEmail `protobuf:"bytes,2,opt,name=parsed_email,json=parsedEmail,proto3" json:"parsed_email,omitempty"`
	XXX_NoUnkeyedLiteral struct{}            `json:"-"`
	XXX_unrecognized     []byte              `json:"-"`
	XXX_sizecache        int32               `json:"-"`
}

func (*ParseEmailResponse) Descriptor

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

func (*ParseEmailResponse) GetParsedEmail

func (m *ParseEmailResponse) GetParsedEmail() *ntypes.ParsedEmail

func (*ParseEmailResponse) GetParsedEmailName

func (m *ParseEmailResponse) GetParsedEmailName() string

func (*ParseEmailResponse) ProtoMessage

func (*ParseEmailResponse) ProtoMessage()

func (*ParseEmailResponse) Reset

func (m *ParseEmailResponse) Reset()

func (*ParseEmailResponse) String

func (m *ParseEmailResponse) String() string

func (*ParseEmailResponse) XXX_DiscardUnknown

func (m *ParseEmailResponse) XXX_DiscardUnknown()

func (*ParseEmailResponse) XXX_Marshal

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

func (*ParseEmailResponse) XXX_Merge

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

func (*ParseEmailResponse) XXX_Size

func (m *ParseEmailResponse) XXX_Size() int

func (*ParseEmailResponse) XXX_Unmarshal

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

type RenderEmailBodyRequest

type RenderEmailBodyRequest struct {
	// The name of a generic file contaning an eml file
	EmlName string `protobuf:"bytes,1,opt,name=eml_name,json=emlName,proto3" json:"eml_name,omitempty"`
	// The whitelist of inline email attachments to include in the rendering,
	// things like: ".jpg", ".jpeg", ".png", ".gif". If empty, then no inline
	// attachments will be rendered in the email body.
	InlineAttachmentWhitelist []string `` /* 138-byte string literal not displayed */
	XXX_NoUnkeyedLiteral      struct{} `json:"-"`
	XXX_unrecognized          []byte   `json:"-"`
	XXX_sizecache             int32    `json:"-"`
}

func (*RenderEmailBodyRequest) Descriptor

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

func (*RenderEmailBodyRequest) GetEmlName

func (m *RenderEmailBodyRequest) GetEmlName() string

func (*RenderEmailBodyRequest) GetInlineAttachmentWhitelist

func (m *RenderEmailBodyRequest) GetInlineAttachmentWhitelist() []string

func (*RenderEmailBodyRequest) ProtoMessage

func (*RenderEmailBodyRequest) ProtoMessage()

func (*RenderEmailBodyRequest) Reset

func (m *RenderEmailBodyRequest) Reset()

func (*RenderEmailBodyRequest) String

func (m *RenderEmailBodyRequest) String() string

func (*RenderEmailBodyRequest) XXX_DiscardUnknown

func (m *RenderEmailBodyRequest) XXX_DiscardUnknown()

func (*RenderEmailBodyRequest) XXX_Marshal

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

func (*RenderEmailBodyRequest) XXX_Merge

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

func (*RenderEmailBodyRequest) XXX_Size

func (m *RenderEmailBodyRequest) XXX_Size() int

func (*RenderEmailBodyRequest) XXX_Unmarshal

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

type RenderEmailBodyResponse

type RenderEmailBodyResponse struct {
	// The generic file ID of the rendered email pdf
	EmailPdfName         string   `protobuf:"bytes,1,opt,name=email_pdf_name,json=emailPdfName,proto3" json:"email_pdf_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RenderEmailBodyResponse) Descriptor

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

func (*RenderEmailBodyResponse) GetEmailPdfName

func (m *RenderEmailBodyResponse) GetEmailPdfName() string

func (*RenderEmailBodyResponse) ProtoMessage

func (*RenderEmailBodyResponse) ProtoMessage()

func (*RenderEmailBodyResponse) Reset

func (m *RenderEmailBodyResponse) Reset()

func (*RenderEmailBodyResponse) String

func (m *RenderEmailBodyResponse) String() string

func (*RenderEmailBodyResponse) XXX_DiscardUnknown

func (m *RenderEmailBodyResponse) XXX_DiscardUnknown()

func (*RenderEmailBodyResponse) XXX_Marshal

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

func (*RenderEmailBodyResponse) XXX_Merge

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

func (*RenderEmailBodyResponse) XXX_Size

func (m *RenderEmailBodyResponse) XXX_Size() int

func (*RenderEmailBodyResponse) XXX_Unmarshal

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

type RenderPdfGSRequest

type RenderPdfGSRequest struct {
	// The name of a generic file containing a pdf file
	PdfName string `protobuf:"bytes,1,opt,name=pdf_name,json=pdfName,proto3" json:"pdf_name,omitempty"`
	// OutputEncoding is the image encoding of the output files. It could be
	// jpg, png, or tiff.
	OutputEncoding ntypes.ImageEncoding `` /* 139-byte string literal not displayed */
	// JpgQuality is the quality metric. It is only used when the OutputEncoding
	// is jpg, otherwise it's ignored. If it's zero it will default to 90
	JpgQuality int32 `protobuf:"varint,3,opt,name=jpg_quality,json=jpgQuality,proto3" json:"jpg_quality,omitempty"`
	// Dpi is the resolution of the output image in dots per inch. If zero it
	// will default to 300. The max Dpi is 600.
	Dpi float32 `protobuf:"fixed32,4,opt,name=dpi,proto3" json:"dpi,omitempty"`
	// MaxLength is the maximum page side length in inches. If a side is longer
	// than this, it will resize the page to the below LongSideResize.
	// If zero, a default of 14.5 inches will be used.
	MaxLength float32 `protobuf:"fixed32,5,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// LongSideResize is the length in inches that that the long side of a page
	// will be resized in the event that a side length is greater than the
	// above MaxLength. If zero, a default of 11 inches will be used.
	LongSideResize       float32  `protobuf:"fixed32,6,opt,name=long_side_resize,json=longSideResize,proto3" json:"long_side_resize,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RenderPdfGSRequest is the Ghostscript version of the RenderPdf rpc. The OutputEncoding must be set to either PNG or JPG. All other parameters are optional.

Use MaxLength and LongSideResize to protect against oversized pages. Here is an example using the defaults of 14.5 inches and 11 respectively with a DPI of 300: Page one is 8.5x14 inches. Since both sides are less than 14.5 inches, it is not resized and the output image will be 2550x4200 pixels. Page two is 10x20 inches. Since one side is longer than 14.5 this will be resized so the long side is 11. The short side is scaled appropiately at 5.5 inches. The final size would by 5.5x11 inches or 1650x3300 pixels.

func (*RenderPdfGSRequest) Descriptor

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

func (*RenderPdfGSRequest) GetDpi

func (m *RenderPdfGSRequest) GetDpi() float32

func (*RenderPdfGSRequest) GetJpgQuality

func (m *RenderPdfGSRequest) GetJpgQuality() int32

func (*RenderPdfGSRequest) GetLongSideResize

func (m *RenderPdfGSRequest) GetLongSideResize() float32

func (*RenderPdfGSRequest) GetMaxLength

func (m *RenderPdfGSRequest) GetMaxLength() float32

func (*RenderPdfGSRequest) GetOutputEncoding

func (m *RenderPdfGSRequest) GetOutputEncoding() ntypes.ImageEncoding

func (*RenderPdfGSRequest) GetPdfName

func (m *RenderPdfGSRequest) GetPdfName() string

func (*RenderPdfGSRequest) ProtoMessage

func (*RenderPdfGSRequest) ProtoMessage()

func (*RenderPdfGSRequest) Reset

func (m *RenderPdfGSRequest) Reset()

func (*RenderPdfGSRequest) String

func (m *RenderPdfGSRequest) String() string

func (*RenderPdfGSRequest) XXX_DiscardUnknown

func (m *RenderPdfGSRequest) XXX_DiscardUnknown()

func (*RenderPdfGSRequest) XXX_Marshal

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

func (*RenderPdfGSRequest) XXX_Merge

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

func (*RenderPdfGSRequest) XXX_Size

func (m *RenderPdfGSRequest) XXX_Size() int

func (*RenderPdfGSRequest) XXX_Unmarshal

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

type RenderPdfGSResponse

type RenderPdfGSResponse struct {
	// The generic file IDs of the rendered pages
	PageNames            []string                  `protobuf:"bytes,1,rep,name=page_names,json=pageNames,proto3" json:"page_names,omitempty"`
	Error                RenderPdfGSResponse_Error `protobuf:"varint,2,opt,name=error,proto3,enum=nsys.api.file.RenderPdfGSResponse_Error" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

func (*RenderPdfGSResponse) Descriptor

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

func (*RenderPdfGSResponse) GetError

func (*RenderPdfGSResponse) GetPageNames

func (m *RenderPdfGSResponse) GetPageNames() []string

func (*RenderPdfGSResponse) ProtoMessage

func (*RenderPdfGSResponse) ProtoMessage()

func (*RenderPdfGSResponse) Reset

func (m *RenderPdfGSResponse) Reset()

func (*RenderPdfGSResponse) String

func (m *RenderPdfGSResponse) String() string

func (*RenderPdfGSResponse) XXX_DiscardUnknown

func (m *RenderPdfGSResponse) XXX_DiscardUnknown()

func (*RenderPdfGSResponse) XXX_Marshal

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

func (*RenderPdfGSResponse) XXX_Merge

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

func (*RenderPdfGSResponse) XXX_Size

func (m *RenderPdfGSResponse) XXX_Size() int

func (*RenderPdfGSResponse) XXX_Unmarshal

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

type RenderPdfGSResponse_Error

type RenderPdfGSResponse_Error int32
const (
	RenderPdfGSResponse_SUCCESS       RenderPdfGSResponse_Error = 0
	RenderPdfGSResponse_ENCRYPTED     RenderPdfGSResponse_Error = 1
	RenderPdfGSResponse_CORRUPTED     RenderPdfGSResponse_Error = 2
	RenderPdfGSResponse_NOT_PERMITTED RenderPdfGSResponse_Error = 3
)

func (RenderPdfGSResponse_Error) EnumDescriptor

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

func (RenderPdfGSResponse_Error) String

func (x RenderPdfGSResponse_Error) String() string

type RenderPdfRequest

type RenderPdfRequest struct {
	// The name of a generic file containing a pdf file
	PdfName string `protobuf:"bytes,1,opt,name=pdf_name,json=pdfName,proto3" json:"pdf_name,omitempty"`
	// OutputEncoding is the image encoding of the output files. It could be
	// jpg, png, or tiff.
	OutputEncoding ntypes.ImageEncoding `` /* 139-byte string literal not displayed */
	// JpgQuality is the quality metric. It is only used when the OutputEncoding
	// is jpg, otherwise it's ignored. If it's zero it will default to 90
	JpgQuality int32 `protobuf:"varint,3,opt,name=jpg_quality,json=jpgQuality,proto3" json:"jpg_quality,omitempty"`
	// Dpi is the resolution of the output image in dots per inch. If zero it
	// will default to 300. The max Dpi is 600.
	Dpi float32 `protobuf:"fixed32,4,opt,name=dpi,proto3" json:"dpi,omitempty"`
	// MaxLength is the maximum page side length in inches. If a side is longer
	// than this, it will resize the page to the below LongSideResize.
	// If zero, a default of 14.5 inches will be used.
	MaxLength float32 `protobuf:"fixed32,5,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// LongSideResize is the length in inches that that the long side of a page
	// will be resized to in the event that the side length is greater than the
	// above MaxLength. If zero, a default of 11 inches will be used.
	LongSideResize float32 `protobuf:"fixed32,6,opt,name=long_side_resize,json=longSideResize,proto3" json:"long_side_resize,omitempty"`
	// If true it will render grayscale images
	Grayscale            bool     `protobuf:"varint,7,opt,name=grayscale,proto3" json:"grayscale,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RenderPdfRequest is the adobe version of the RenderPdf rpc. The OutputEncoding must be set to either PNG or JPG. All other parameters are optional.

Use MaxLength and LongSideResize to protect against oversized pages. Here is an example using the defaults of 14.5 inches and 11 respectively with a DPI of 300: Page one is 8.5x14 inches. Since both sides are less than 14.5 inches, it is not resized and the output image will be 2550x4200 pixels. Page two is 10x20 inches. Since one side is longer than 14.5 this will be resized so the long side is 11. The short side is scaled appropiately at 5.5 inches. The final size would by 5.5x11 inches or 1650x3300 pixels.

func (*RenderPdfRequest) Descriptor

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

func (*RenderPdfRequest) GetDpi

func (m *RenderPdfRequest) GetDpi() float32

func (*RenderPdfRequest) GetGrayscale

func (m *RenderPdfRequest) GetGrayscale() bool

func (*RenderPdfRequest) GetJpgQuality

func (m *RenderPdfRequest) GetJpgQuality() int32

func (*RenderPdfRequest) GetLongSideResize

func (m *RenderPdfRequest) GetLongSideResize() float32

func (*RenderPdfRequest) GetMaxLength

func (m *RenderPdfRequest) GetMaxLength() float32

func (*RenderPdfRequest) GetOutputEncoding

func (m *RenderPdfRequest) GetOutputEncoding() ntypes.ImageEncoding

func (*RenderPdfRequest) GetPdfName

func (m *RenderPdfRequest) GetPdfName() string

func (*RenderPdfRequest) ProtoMessage

func (*RenderPdfRequest) ProtoMessage()

func (*RenderPdfRequest) Reset

func (m *RenderPdfRequest) Reset()

func (*RenderPdfRequest) String

func (m *RenderPdfRequest) String() string

func (*RenderPdfRequest) XXX_DiscardUnknown

func (m *RenderPdfRequest) XXX_DiscardUnknown()

func (*RenderPdfRequest) XXX_Marshal

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

func (*RenderPdfRequest) XXX_Merge

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

func (*RenderPdfRequest) XXX_Size

func (m *RenderPdfRequest) XXX_Size() int

func (*RenderPdfRequest) XXX_Unmarshal

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

type RenderPdfResponse

type RenderPdfResponse struct {
	// The generic file IDs of the rendered pages
	PageNames            []string                `protobuf:"bytes,1,rep,name=page_names,json=pageNames,proto3" json:"page_names,omitempty"`
	Error                RenderPdfResponse_Error `protobuf:"varint,2,opt,name=error,proto3,enum=nsys.api.file.RenderPdfResponse_Error" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

func (*RenderPdfResponse) Descriptor

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

func (*RenderPdfResponse) GetError

func (*RenderPdfResponse) GetPageNames

func (m *RenderPdfResponse) GetPageNames() []string

func (*RenderPdfResponse) ProtoMessage

func (*RenderPdfResponse) ProtoMessage()

func (*RenderPdfResponse) Reset

func (m *RenderPdfResponse) Reset()

func (*RenderPdfResponse) String

func (m *RenderPdfResponse) String() string

func (*RenderPdfResponse) XXX_DiscardUnknown

func (m *RenderPdfResponse) XXX_DiscardUnknown()

func (*RenderPdfResponse) XXX_Marshal

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

func (*RenderPdfResponse) XXX_Merge

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

func (*RenderPdfResponse) XXX_Size

func (m *RenderPdfResponse) XXX_Size() int

func (*RenderPdfResponse) XXX_Unmarshal

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

type RenderPdfResponse_Error

type RenderPdfResponse_Error int32
const (
	RenderPdfResponse_SUCCESS       RenderPdfResponse_Error = 0
	RenderPdfResponse_ENCRYPTED     RenderPdfResponse_Error = 1
	RenderPdfResponse_CORRUPTED     RenderPdfResponse_Error = 2
	RenderPdfResponse_NOT_PERMITTED RenderPdfResponse_Error = 3
)

func (RenderPdfResponse_Error) EnumDescriptor

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

func (RenderPdfResponse_Error) String

func (x RenderPdfResponse_Error) String() string

type SplitTiffRequest

type SplitTiffRequest struct {
	// The name of a generic file containing a tiff file
	TiffName             string   `protobuf:"bytes,1,opt,name=tiff_name,json=tiffName,proto3" json:"tiff_name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*SplitTiffRequest) Descriptor

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

func (*SplitTiffRequest) GetTiffName

func (m *SplitTiffRequest) GetTiffName() string

func (*SplitTiffRequest) ProtoMessage

func (*SplitTiffRequest) ProtoMessage()

func (*SplitTiffRequest) Reset

func (m *SplitTiffRequest) Reset()

func (*SplitTiffRequest) String

func (m *SplitTiffRequest) String() string

func (*SplitTiffRequest) XXX_DiscardUnknown

func (m *SplitTiffRequest) XXX_DiscardUnknown()

func (*SplitTiffRequest) XXX_Marshal

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

func (*SplitTiffRequest) XXX_Merge

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

func (*SplitTiffRequest) XXX_Size

func (m *SplitTiffRequest) XXX_Size() int

func (*SplitTiffRequest) XXX_Unmarshal

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

type SplitTiffResponse

type SplitTiffResponse struct {
	// The generic file IDs of the individual pages
	PageNames            []string                `protobuf:"bytes,1,rep,name=page_names,json=pageNames,proto3" json:"page_names,omitempty"`
	Error                SplitTiffResponse_Error `protobuf:"varint,2,opt,name=error,proto3,enum=nsys.api.file.SplitTiffResponse_Error" json:"error,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                `json:"-"`
	XXX_unrecognized     []byte                  `json:"-"`
	XXX_sizecache        int32                   `json:"-"`
}

func (*SplitTiffResponse) Descriptor

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

func (*SplitTiffResponse) GetError

func (*SplitTiffResponse) GetPageNames

func (m *SplitTiffResponse) GetPageNames() []string

func (*SplitTiffResponse) ProtoMessage

func (*SplitTiffResponse) ProtoMessage()

func (*SplitTiffResponse) Reset

func (m *SplitTiffResponse) Reset()

func (*SplitTiffResponse) String

func (m *SplitTiffResponse) String() string

func (*SplitTiffResponse) XXX_DiscardUnknown

func (m *SplitTiffResponse) XXX_DiscardUnknown()

func (*SplitTiffResponse) XXX_Marshal

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

func (*SplitTiffResponse) XXX_Merge

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

func (*SplitTiffResponse) XXX_Size

func (m *SplitTiffResponse) XXX_Size() int

func (*SplitTiffResponse) XXX_Unmarshal

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

type SplitTiffResponse_Error

type SplitTiffResponse_Error int32
const (
	SplitTiffResponse_SUCCESS   SplitTiffResponse_Error = 0
	SplitTiffResponse_CORRUPTED SplitTiffResponse_Error = 1
)

func (SplitTiffResponse_Error) EnumDescriptor

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

func (SplitTiffResponse_Error) String

func (x SplitTiffResponse_Error) String() string

type UnimplementedFileProcessingServer

type UnimplementedFileProcessingServer struct {
}

UnimplementedFileProcessingServer can be embedded to have forward compatible implementations.

func (*UnimplementedFileProcessingServer) CreateFileset

func (*UnimplementedFileProcessingServer) CreateFilesetLRO

func (*UnimplementedFileProcessingServer) DeleteResult

func (*UnimplementedFileProcessingServer) DeleteResultLRO

func (*UnimplementedFileProcessingServer) DocToPdf

func (*UnimplementedFileProcessingServer) DocToPdfLRO

func (*UnimplementedFileProcessingServer) GetGenericFile

func (*UnimplementedFileProcessingServer) GetGenericFileLRO

func (*UnimplementedFileProcessingServer) GetResult

func (*UnimplementedFileProcessingServer) GetResultLRO

func (*UnimplementedFileProcessingServer) InitiateProcessing

func (*UnimplementedFileProcessingServer) InitiateProcessingLRO

func (*UnimplementedFileProcessingServer) ListResults

func (*UnimplementedFileProcessingServer) ListResultsLRO

func (*UnimplementedFileProcessingServer) ParseEmail

func (*UnimplementedFileProcessingServer) ParseEmailLRO

func (*UnimplementedFileProcessingServer) RenderEmailBody

func (*UnimplementedFileProcessingServer) RenderEmailBodyLRO

func (*UnimplementedFileProcessingServer) RenderPdf

func (*UnimplementedFileProcessingServer) RenderPdfGS

func (*UnimplementedFileProcessingServer) RenderPdfGSLRO

func (*UnimplementedFileProcessingServer) RenderPdfLRO

func (*UnimplementedFileProcessingServer) SplitTiff

func (*UnimplementedFileProcessingServer) SplitTiffLRO

func (*UnimplementedFileProcessingServer) UploadGenericFile

func (*UnimplementedFileProcessingServer) UploadGenericFileLRO

type UploadGenericFileRequest

type UploadGenericFileRequest struct {
	// The file's identifier which must be unique within the
	// account and must match the regex '^[0-9A-Za-z.-]{1,48}$'.
	// Automatically generated if not supplied in upload request.
	Name        string              `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	GenericFile *ntypes.GenericFile `protobuf:"bytes,2,opt,name=generic_file,json=genericFile,proto3" json:"generic_file,omitempty"`
	// Requested file expiration time. The time is capped to comply with
	// account-specific minimums and maximums. A zero value requests the
	// maximum allowable expiration time be used.
	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 (*UploadGenericFileRequest) Descriptor

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

func (*UploadGenericFileRequest) GetExpireTime

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

func (*UploadGenericFileRequest) GetGenericFile

func (m *UploadGenericFileRequest) GetGenericFile() *ntypes.GenericFile

func (*UploadGenericFileRequest) GetName

func (m *UploadGenericFileRequest) GetName() string

func (*UploadGenericFileRequest) ProtoMessage

func (*UploadGenericFileRequest) ProtoMessage()

func (*UploadGenericFileRequest) Reset

func (m *UploadGenericFileRequest) Reset()

func (*UploadGenericFileRequest) String

func (m *UploadGenericFileRequest) String() string

func (*UploadGenericFileRequest) XXX_DiscardUnknown

func (m *UploadGenericFileRequest) XXX_DiscardUnknown()

func (*UploadGenericFileRequest) XXX_Marshal

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

func (*UploadGenericFileRequest) XXX_Merge

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

func (*UploadGenericFileRequest) XXX_Size

func (m *UploadGenericFileRequest) XXX_Size() int

func (*UploadGenericFileRequest) XXX_Unmarshal

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

type UploadGenericFileResponse

type UploadGenericFileResponse struct {
	// Identifier for the uploaded file.
	Name string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"`
	// The actual expiration time for the file.
	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 (*UploadGenericFileResponse) Descriptor

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

func (*UploadGenericFileResponse) GetExpireTime

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

func (*UploadGenericFileResponse) GetName

func (m *UploadGenericFileResponse) GetName() string

func (*UploadGenericFileResponse) ProtoMessage

func (*UploadGenericFileResponse) ProtoMessage()

func (*UploadGenericFileResponse) Reset

func (m *UploadGenericFileResponse) Reset()

func (*UploadGenericFileResponse) String

func (m *UploadGenericFileResponse) String() string

func (*UploadGenericFileResponse) XXX_DiscardUnknown

func (m *UploadGenericFileResponse) XXX_DiscardUnknown()

func (*UploadGenericFileResponse) XXX_Marshal

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

func (*UploadGenericFileResponse) XXX_Merge

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

func (*UploadGenericFileResponse) XXX_Size

func (m *UploadGenericFileResponse) XXX_Size() int

func (*UploadGenericFileResponse) XXX_Unmarshal

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

Jump to

Keyboard shortcuts

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