Enum value maps for UpdateType.
var (
UpdateType_name = map[int32]string{
0: "UPDATE_TYPE_UNSPECIFIED",
1: "UPDATE_TYPE_REPLACE",
2: "UPDATE_TYPE_MERGE",
3: "UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES",
4: "UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES",
5: "UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES",
}
UpdateType_value = map[string]int32{
"UPDATE_TYPE_UNSPECIFIED": 0,
"UPDATE_TYPE_REPLACE": 1,
"UPDATE_TYPE_MERGE": 2,
"UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES": 3,
"UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES": 4,
"UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES": 5,
}
)
Enum value maps for DatabaseType.
var (
DatabaseType_name = map[int32]string{
0: "DB_UNKNOWN",
1: "DB_INFRA_SPANNER",
2: "DB_CLOUD_SQL_POSTGRES",
}
DatabaseType_value = map[string]int32{
"DB_UNKNOWN": 0,
"DB_INFRA_SPANNER": 1,
"DB_CLOUD_SQL_POSTGRES": 2,
}
)
Enum value maps for AccessControlMode.
var (
AccessControlMode_name = map[int32]string{
0: "ACL_MODE_UNKNOWN",
1: "ACL_MODE_UNIVERSAL_ACCESS",
2: "ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID",
3: "ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI",
}
AccessControlMode_value = map[string]int32{
"ACL_MODE_UNKNOWN": 0,
"ACL_MODE_UNIVERSAL_ACCESS": 1,
"ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID": 2,
"ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI": 3,
}
)
Enum value maps for RawDocumentFileType.
var (
RawDocumentFileType_name = map[int32]string{
0: "RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED",
1: "RAW_DOCUMENT_FILE_TYPE_PDF",
2: "RAW_DOCUMENT_FILE_TYPE_DOCX",
3: "RAW_DOCUMENT_FILE_TYPE_XLSX",
4: "RAW_DOCUMENT_FILE_TYPE_PPTX",
5: "RAW_DOCUMENT_FILE_TYPE_TEXT",
}
RawDocumentFileType_value = map[string]int32{
"RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED": 0,
"RAW_DOCUMENT_FILE_TYPE_PDF": 1,
"RAW_DOCUMENT_FILE_TYPE_DOCX": 2,
"RAW_DOCUMENT_FILE_TYPE_XLSX": 3,
"RAW_DOCUMENT_FILE_TYPE_PPTX": 4,
"RAW_DOCUMENT_FILE_TYPE_TEXT": 5,
}
)
Enum value maps for DocumentLink_State.
var (
DocumentLink_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "ACTIVE",
2: "SOFT_DELETED",
}
DocumentLink_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"ACTIVE": 1,
"SOFT_DELETED": 2,
}
)
Enum value maps for TimeFilter_TimeField.
var (
TimeFilter_TimeField_name = map[int32]string{
0: "TIME_FIELD_UNSPECIFIED",
1: "CREATE_TIME",
2: "UPDATE_TIME",
}
TimeFilter_TimeField_value = map[string]int32{
"TIME_FIELD_UNSPECIFIED": 0,
"CREATE_TIME": 1,
"UPDATE_TIME": 2,
}
)
Enum value maps for FileTypeFilter_FileType.
var (
FileTypeFilter_FileType_name = map[int32]string{
0: "FILE_TYPE_UNSPECIFIED",
1: "ALL",
2: "FOLDER",
3: "DOCUMENT",
}
FileTypeFilter_FileType_value = map[string]int32{
"FILE_TYPE_UNSPECIFIED": 0,
"ALL": 1,
"FOLDER": 2,
"DOCUMENT": 3,
}
)
Enum value maps for HistogramQueryPropertyNameFilter_HistogramYAxis.
var (
HistogramQueryPropertyNameFilter_HistogramYAxis_name = map[int32]string{
0: "HISTOGRAM_YAXIS_DOCUMENT",
1: "HISTOGRAM_YAXIS_PROPERTY",
}
HistogramQueryPropertyNameFilter_HistogramYAxis_value = map[string]int32{
"HISTOGRAM_YAXIS_DOCUMENT": 0,
"HISTOGRAM_YAXIS_PROPERTY": 1,
}
)
Enum value maps for Rule_TriggerType.
var (
Rule_TriggerType_name = map[int32]string{
0: "UNKNOWN",
1: "ON_CREATE",
4: "ON_UPDATE",
}
Rule_TriggerType_value = map[string]int32{
"UNKNOWN": 0,
"ON_CREATE": 1,
"ON_UPDATE": 4,
}
)
Enum value maps for AccessControlAction_OperationType.
var (
AccessControlAction_OperationType_name = map[int32]string{
0: "UNKNOWN",
1: "ADD_POLICY_BINDING",
2: "REMOVE_POLICY_BINDING",
3: "REPLACE_POLICY_BINDING",
}
AccessControlAction_OperationType_value = map[string]int32{
"UNKNOWN": 0,
"ADD_POLICY_BINDING": 1,
"REMOVE_POLICY_BINDING": 2,
"REPLACE_POLICY_BINDING": 3,
}
)
Enum value maps for ActionOutput_State.
var (
ActionOutput_State_name = map[int32]string{
0: "UNKNOWN",
1: "ACTION_SUCCEEDED",
2: "ACTION_FAILED",
3: "ACTION_TIMED_OUT",
4: "ACTION_PENDING",
}
ActionOutput_State_value = map[string]int32{
"UNKNOWN": 0,
"ACTION_SUCCEEDED": 1,
"ACTION_FAILED": 2,
"ACTION_TIMED_OUT": 3,
"ACTION_PENDING": 4,
}
)
var File_google_cloud_contentwarehouse_v1_async_document_service_request_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_common_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_link_service_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_schema_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_schema_service_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_service_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_document_service_request_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_filters_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_histogram_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_rule_engine_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_ruleset_service_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_ruleset_service_request_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_synonymset_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_synonymset_service_proto protoreflect.FileDescriptor
var File_google_cloud_contentwarehouse_v1_synonymset_service_request_proto protoreflect.FileDescriptor
func RegisterDocumentLinkServiceServer(s *grpc.Server, srv DocumentLinkServiceServer)
func RegisterDocumentSchemaServiceServer(s *grpc.Server, srv DocumentSchemaServiceServer)
func RegisterDocumentServiceServer(s *grpc.Server, srv DocumentServiceServer)
func RegisterRuleSetServiceServer(s *grpc.Server, srv RuleSetServiceServer)
func RegisterSynonymSetServiceServer(s *grpc.Server, srv SynonymSetServiceServer)
Represents the action responsible for access control list management operations.
type AccessControlAction struct {
// Identifies the type of operation.
OperationType AccessControlAction_OperationType `protobuf:"varint,1,opt,name=operation_type,json=operationType,proto3,enum=google.cloud.contentwarehouse.v1.AccessControlAction_OperationType" json:"operation_type,omitempty"`
// Represents the new policy from which bindings are added, removed or
// replaced based on the type of the operation. the policy is limited to a few
// 10s of KB.
Policy *v1.Policy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`
// contains filtered or unexported fields
}
func (*AccessControlAction) Descriptor() ([]byte, []int)
Deprecated: Use AccessControlAction.ProtoReflect.Descriptor instead.
func (x *AccessControlAction) GetOperationType() AccessControlAction_OperationType
func (x *AccessControlAction) GetPolicy() *v1.Policy
func (*AccessControlAction) ProtoMessage()
func (x *AccessControlAction) ProtoReflect() protoreflect.Message
func (x *AccessControlAction) Reset()
func (x *AccessControlAction) String() string
Type of ACL modification operation.
type AccessControlAction_OperationType int32
const (
AccessControlAction_UNKNOWN AccessControlAction_OperationType = 0
// Adds newly given policy bindings in the existing bindings list.
AccessControlAction_ADD_POLICY_BINDING AccessControlAction_OperationType = 1
// Removes newly given policy bindings from the existing bindings list.
AccessControlAction_REMOVE_POLICY_BINDING AccessControlAction_OperationType = 2
// Replaces existing policy bindings with the given policy binding list
AccessControlAction_REPLACE_POLICY_BINDING AccessControlAction_OperationType = 3
)
func (AccessControlAction_OperationType) Descriptor() protoreflect.EnumDescriptor
func (x AccessControlAction_OperationType) Enum() *AccessControlAction_OperationType
func (AccessControlAction_OperationType) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccessControlAction_OperationType.Descriptor instead.
func (x AccessControlAction_OperationType) Number() protoreflect.EnumNumber
func (x AccessControlAction_OperationType) String() string
func (AccessControlAction_OperationType) Type() protoreflect.EnumType
Access Control Mode.
type AccessControlMode int32
const (
// This value is required by protobuf best practices
AccessControlMode_ACL_MODE_UNKNOWN AccessControlMode = 0
// Universal Access: No document level access control.
AccessControlMode_ACL_MODE_UNIVERSAL_ACCESS AccessControlMode = 1
// Document level access control with customer own Identity Service.
AccessControlMode_ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID AccessControlMode = 2
// Document level access control using Google Cloud Identity.
AccessControlMode_ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI AccessControlMode = 3
)
func (AccessControlMode) Descriptor() protoreflect.EnumDescriptor
func (x AccessControlMode) Enum() *AccessControlMode
func (AccessControlMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccessControlMode.Descriptor instead.
func (x AccessControlMode) Number() protoreflect.EnumNumber
func (x AccessControlMode) String() string
func (AccessControlMode) Type() protoreflect.EnumType
Represents the action triggered by Rule Engine when the rule is true.
type Action struct {
// ID of the action. Managed internally.
ActionId string `protobuf:"bytes,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
// Types that are assignable to Action:
//
// *Action_AccessControl
// *Action_DataValidation
// *Action_DataUpdate
// *Action_AddToFolder
// *Action_PublishToPubSub
// *Action_RemoveFromFolderAction
// *Action_DeleteDocumentAction
Action isAction_Action `protobuf_oneof:"action"`
// contains filtered or unexported fields
}
func (*Action) Descriptor() ([]byte, []int)
Deprecated: Use Action.ProtoReflect.Descriptor instead.
func (x *Action) GetAccessControl() *AccessControlAction
func (m *Action) GetAction() isAction_Action
func (x *Action) GetActionId() string
func (x *Action) GetAddToFolder() *AddToFolderAction
func (x *Action) GetDataUpdate() *DataUpdateAction
func (x *Action) GetDataValidation() *DataValidationAction
func (x *Action) GetDeleteDocumentAction() *DeleteDocumentAction
func (x *Action) GetPublishToPubSub() *PublishAction
func (x *Action) GetRemoveFromFolderAction() *RemoveFromFolderAction
func (*Action) ProtoMessage()
func (x *Action) ProtoReflect() protoreflect.Message
func (x *Action) Reset()
func (x *Action) String() string
Represents the output of the Action Executor.
type ActionExecutorOutput struct {
// List of rule and corresponding actions result.
RuleActionsPairs []*RuleActionsPair `protobuf:"bytes,1,rep,name=rule_actions_pairs,json=ruleActionsPairs,proto3" json:"rule_actions_pairs,omitempty"`
// contains filtered or unexported fields
}
func (*ActionExecutorOutput) Descriptor() ([]byte, []int)
Deprecated: Use ActionExecutorOutput.ProtoReflect.Descriptor instead.
func (x *ActionExecutorOutput) GetRuleActionsPairs() []*RuleActionsPair
func (*ActionExecutorOutput) ProtoMessage()
func (x *ActionExecutorOutput) ProtoReflect() protoreflect.Message
func (x *ActionExecutorOutput) Reset()
func (x *ActionExecutorOutput) String() string
Represents the result of executing an action.
type ActionOutput struct {
// ID of the action.
ActionId string `protobuf:"bytes,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
// State of an action.
ActionState ActionOutput_State `protobuf:"varint,2,opt,name=action_state,json=actionState,proto3,enum=google.cloud.contentwarehouse.v1.ActionOutput_State" json:"action_state,omitempty"`
// Action execution output message.
OutputMessage string `protobuf:"bytes,3,opt,name=output_message,json=outputMessage,proto3" json:"output_message,omitempty"`
// contains filtered or unexported fields
}
func (*ActionOutput) Descriptor() ([]byte, []int)
Deprecated: Use ActionOutput.ProtoReflect.Descriptor instead.
func (x *ActionOutput) GetActionId() string
func (x *ActionOutput) GetActionState() ActionOutput_State
func (x *ActionOutput) GetOutputMessage() string
func (*ActionOutput) ProtoMessage()
func (x *ActionOutput) ProtoReflect() protoreflect.Message
func (x *ActionOutput) Reset()
func (x *ActionOutput) String() string
Represents execution state of the action.
type ActionOutput_State int32
const (
ActionOutput_UNKNOWN ActionOutput_State = 0
// State indicating action executed successfully.
ActionOutput_ACTION_SUCCEEDED ActionOutput_State = 1
// State indicating action failed.
ActionOutput_ACTION_FAILED ActionOutput_State = 2
// State indicating action timed out.
ActionOutput_ACTION_TIMED_OUT ActionOutput_State = 3
// State indicating action is pending.
ActionOutput_ACTION_PENDING ActionOutput_State = 4
)
func (ActionOutput_State) Descriptor() protoreflect.EnumDescriptor
func (x ActionOutput_State) Enum() *ActionOutput_State
func (ActionOutput_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use ActionOutput_State.Descriptor instead.
func (x ActionOutput_State) Number() protoreflect.EnumNumber
func (x ActionOutput_State) String() string
func (ActionOutput_State) Type() protoreflect.EnumType
type Action_AccessControl struct {
// Action triggering access control operations.
AccessControl *AccessControlAction `protobuf:"bytes,2,opt,name=access_control,json=accessControl,proto3,oneof"`
}
type Action_AddToFolder struct {
// Action triggering create document link operation.
AddToFolder *AddToFolderAction `protobuf:"bytes,5,opt,name=add_to_folder,json=addToFolder,proto3,oneof"`
}
type Action_DataUpdate struct {
// Action triggering data update operations.
DataUpdate *DataUpdateAction `protobuf:"bytes,4,opt,name=data_update,json=dataUpdate,proto3,oneof"`
}
type Action_DataValidation struct {
// Action triggering data validation operations.
DataValidation *DataValidationAction `protobuf:"bytes,3,opt,name=data_validation,json=dataValidation,proto3,oneof"`
}
type Action_DeleteDocumentAction struct {
// Action deleting the document.
DeleteDocumentAction *DeleteDocumentAction `protobuf:"bytes,10,opt,name=delete_document_action,json=deleteDocumentAction,proto3,oneof"`
}
type Action_PublishToPubSub struct {
// Action publish to Pub/Sub operation.
PublishToPubSub *PublishAction `protobuf:"bytes,6,opt,name=publish_to_pub_sub,json=publishToPubSub,proto3,oneof"`
}
type Action_RemoveFromFolderAction struct {
// Action removing a document from a folder.
RemoveFromFolderAction *RemoveFromFolderAction `protobuf:"bytes,9,opt,name=remove_from_folder_action,json=removeFromFolderAction,proto3,oneof"`
}
Represents the action responsible for adding document under a folder.
type AddToFolderAction struct {
// Names of the folder under which new document is to be added.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}.
Folders []string `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
// contains filtered or unexported fields
}
func (*AddToFolderAction) Descriptor() ([]byte, []int)
Deprecated: Use AddToFolderAction.ProtoReflect.Descriptor instead.
func (x *AddToFolderAction) GetFolders() []string
func (*AddToFolderAction) ProtoMessage()
func (x *AddToFolderAction) ProtoReflect() protoreflect.Message
func (x *AddToFolderAction) Reset()
func (x *AddToFolderAction) String() string
Request Option for processing Cloud AI Document in CW Document.
type CloudAIDocumentOption struct {
// Whether to convert all the entities to properties.
EnableEntitiesConversions bool `protobuf:"varint,1,opt,name=enable_entities_conversions,json=enableEntitiesConversions,proto3" json:"enable_entities_conversions,omitempty"`
// If set, only selected entities will be converted to properties.
CustomizedEntitiesPropertiesConversions map[string]string `protobuf:"bytes,2,rep,name=customized_entities_properties_conversions,json=customizedEntitiesPropertiesConversions,proto3" json:"customized_entities_properties_conversions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*CloudAIDocumentOption) Descriptor() ([]byte, []int)
Deprecated: Use CloudAIDocumentOption.ProtoReflect.Descriptor instead.
func (x *CloudAIDocumentOption) GetCustomizedEntitiesPropertiesConversions() map[string]string
func (x *CloudAIDocumentOption) GetEnableEntitiesConversions() bool
func (*CloudAIDocumentOption) ProtoMessage()
func (x *CloudAIDocumentOption) ProtoReflect() protoreflect.Message
func (x *CloudAIDocumentOption) Reset()
func (x *CloudAIDocumentOption) String() string
Request message for DocumentLinkService.CreateDocumentLink.
type CreateDocumentLinkRequest struct {
// Required. Parent of the document-link to be created.
// parent of document-link should be a document.
// Format:
// projects/{project_number}/locations/{location}/documents/{source_document_id}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Document links associated with the source documents (source_document_id).
DocumentLink *DocumentLink `protobuf:"bytes,2,opt,name=document_link,json=documentLink,proto3" json:"document_link,omitempty"`
// The meta information collected about the document creator, used to enforce
// access control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,3,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDocumentLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentLinkRequest.ProtoReflect.Descriptor instead.
func (x *CreateDocumentLinkRequest) GetDocumentLink() *DocumentLink
func (x *CreateDocumentLinkRequest) GetParent() string
func (x *CreateDocumentLinkRequest) GetRequestMetadata() *RequestMetadata
func (*CreateDocumentLinkRequest) ProtoMessage()
func (x *CreateDocumentLinkRequest) ProtoReflect() protoreflect.Message
func (x *CreateDocumentLinkRequest) Reset()
func (x *CreateDocumentLinkRequest) String() string
Metadata object for CreateDocument request (currently empty).
type CreateDocumentMetadata struct {
// contains filtered or unexported fields
}
func (*CreateDocumentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentMetadata.ProtoReflect.Descriptor instead.
func (*CreateDocumentMetadata) ProtoMessage()
func (x *CreateDocumentMetadata) ProtoReflect() protoreflect.Message
func (x *CreateDocumentMetadata) Reset()
func (x *CreateDocumentMetadata) String() string
Request message for DocumentService.CreateDocument.
type CreateDocumentRequest struct {
// Required. The parent name.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The document to create.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,3,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// Default document policy during creation. Conditions defined in the policy
// will be ignored.
Policy *v1.Policy `protobuf:"bytes,4,opt,name=policy,proto3" json:"policy,omitempty"`
// Request Option for processing Cloud AI Document in CW Document.
CloudAiDocumentOption *CloudAIDocumentOption `protobuf:"bytes,5,opt,name=cloud_ai_document_option,json=cloudAiDocumentOption,proto3" json:"cloud_ai_document_option,omitempty"`
// Field mask for creating Document fields. If mask path is empty,
// it means all fields are masked.
// For the `FieldMask` definition,
// see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
CreateMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=create_mask,json=createMask,proto3" json:"create_mask,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *CreateDocumentRequest) GetCloudAiDocumentOption() *CloudAIDocumentOption
func (x *CreateDocumentRequest) GetCreateMask() *fieldmaskpb.FieldMask
func (x *CreateDocumentRequest) GetDocument() *Document
func (x *CreateDocumentRequest) GetParent() string
func (x *CreateDocumentRequest) GetPolicy() *v1.Policy
func (x *CreateDocumentRequest) GetRequestMetadata() *RequestMetadata
func (*CreateDocumentRequest) ProtoMessage()
func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *CreateDocumentRequest) Reset()
func (x *CreateDocumentRequest) String() string
Response message for DocumentService.CreateDocument.
type CreateDocumentResponse struct {
// Document created after executing create request.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// Output from Rule Engine recording the rule evaluator and action executor's
// output.
//
// Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto
RuleEngineOutput *RuleEngineOutput `protobuf:"bytes,2,opt,name=rule_engine_output,json=ruleEngineOutput,proto3" json:"rule_engine_output,omitempty"`
// Additional information for the API invocation, such as the request tracking
// id.
Metadata *ResponseMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDocumentResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentResponse.ProtoReflect.Descriptor instead.
func (x *CreateDocumentResponse) GetDocument() *Document
func (x *CreateDocumentResponse) GetMetadata() *ResponseMetadata
func (x *CreateDocumentResponse) GetRuleEngineOutput() *RuleEngineOutput
func (*CreateDocumentResponse) ProtoMessage()
func (x *CreateDocumentResponse) ProtoReflect() protoreflect.Message
func (x *CreateDocumentResponse) Reset()
func (x *CreateDocumentResponse) String() string
Request message for DocumentSchemaService.CreateDocumentSchema.
type CreateDocumentSchemaRequest struct {
// Required. The parent name.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The document schema to create.
DocumentSchema *DocumentSchema `protobuf:"bytes,2,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDocumentSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentSchemaRequest.ProtoReflect.Descriptor instead.
func (x *CreateDocumentSchemaRequest) GetDocumentSchema() *DocumentSchema
func (x *CreateDocumentSchemaRequest) GetParent() string
func (*CreateDocumentSchemaRequest) ProtoMessage()
func (x *CreateDocumentSchemaRequest) ProtoReflect() protoreflect.Message
func (x *CreateDocumentSchemaRequest) Reset()
func (x *CreateDocumentSchemaRequest) String() string
Request message for RuleSetService.CreateRuleSet.
type CreateRuleSetRequest struct {
// Required. The parent name.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The rule set to create.
RuleSet *RuleSet `protobuf:"bytes,2,opt,name=rule_set,json=ruleSet,proto3" json:"rule_set,omitempty"`
// contains filtered or unexported fields
}
func (*CreateRuleSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateRuleSetRequest.ProtoReflect.Descriptor instead.
func (x *CreateRuleSetRequest) GetParent() string
func (x *CreateRuleSetRequest) GetRuleSet() *RuleSet
func (*CreateRuleSetRequest) ProtoMessage()
func (x *CreateRuleSetRequest) ProtoReflect() protoreflect.Message
func (x *CreateRuleSetRequest) Reset()
func (x *CreateRuleSetRequest) String() string
Request message for SynonymSetService.CreateSynonymSet.
type CreateSynonymSetRequest struct {
// Required. The parent name.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The synonymSet to be created for a context
SynonymSet *SynonymSet `protobuf:"bytes,2,opt,name=synonym_set,json=synonymSet,proto3" json:"synonym_set,omitempty"`
// contains filtered or unexported fields
}
func (*CreateSynonymSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateSynonymSetRequest.ProtoReflect.Descriptor instead.
func (x *CreateSynonymSetRequest) GetParent() string
func (x *CreateSynonymSetRequest) GetSynonymSet() *SynonymSet
func (*CreateSynonymSetRequest) ProtoMessage()
func (x *CreateSynonymSetRequest) ProtoReflect() protoreflect.Message
func (x *CreateSynonymSetRequest) Reset()
func (x *CreateSynonymSetRequest) String() string
Represents the action responsible for properties update operations.
type DataUpdateAction struct {
// Map of (K, V) -> (valid name of the field, new value of the field)
// E.g., ("age", "60") entry triggers update of field age with a value of 60.
// If the field is not present then new entry is added.
// During update action execution, value strings will be casted to
// appropriate types.
Entries map[string]string `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*DataUpdateAction) Descriptor() ([]byte, []int)
Deprecated: Use DataUpdateAction.ProtoReflect.Descriptor instead.
func (x *DataUpdateAction) GetEntries() map[string]string
func (*DataUpdateAction) ProtoMessage()
func (x *DataUpdateAction) ProtoReflect() protoreflect.Message
func (x *DataUpdateAction) Reset()
func (x *DataUpdateAction) String() string
Represents the action responsible for data validation operations.
type DataValidationAction struct {
// Map of (K, V) -> (field, string condition to be evaluated on the field)
// E.g., ("age", "age > 18 && age < 60") entry triggers validation of field
// age with the given condition. Map entries will be ANDed during validation.
Conditions map[string]string `protobuf:"bytes,1,rep,name=conditions,proto3" json:"conditions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*DataValidationAction) Descriptor() ([]byte, []int)
Deprecated: Use DataValidationAction.ProtoReflect.Descriptor instead.
func (x *DataValidationAction) GetConditions() map[string]string
func (*DataValidationAction) ProtoMessage()
func (x *DataValidationAction) ProtoReflect() protoreflect.Message
func (x *DataValidationAction) Reset()
func (x *DataValidationAction) String() string
Type of database used by the customer
type DatabaseType int32
const (
// This value is required by protobuf best practices
DatabaseType_DB_UNKNOWN DatabaseType = 0
// Internal Spanner
DatabaseType_DB_INFRA_SPANNER DatabaseType = 1
// Cloud Sql with a Postgres Sql instance
DatabaseType_DB_CLOUD_SQL_POSTGRES DatabaseType = 2
)
func (DatabaseType) Descriptor() protoreflect.EnumDescriptor
func (x DatabaseType) Enum() *DatabaseType
func (DatabaseType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DatabaseType.Descriptor instead.
func (x DatabaseType) Number() protoreflect.EnumNumber
func (x DatabaseType) String() string
func (DatabaseType) Type() protoreflect.EnumType
DateTime values.
type DateTimeArray struct {
// List of datetime values.
// Both OffsetDateTime and ZonedDateTime are supported.
Values []*datetime.DateTime `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*DateTimeArray) Descriptor() ([]byte, []int)
Deprecated: Use DateTimeArray.ProtoReflect.Descriptor instead.
func (x *DateTimeArray) GetValues() []*datetime.DateTime
func (*DateTimeArray) ProtoMessage()
func (x *DateTimeArray) ProtoReflect() protoreflect.Message
func (x *DateTimeArray) Reset()
func (x *DateTimeArray) String() string
Configurations for a date time property.
type DateTimeTypeOptions struct {
// contains filtered or unexported fields
}
func (*DateTimeTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use DateTimeTypeOptions.ProtoReflect.Descriptor instead.
func (*DateTimeTypeOptions) ProtoMessage()
func (x *DateTimeTypeOptions) ProtoReflect() protoreflect.Message
func (x *DateTimeTypeOptions) Reset()
func (x *DateTimeTypeOptions) String() string
Represents the action responsible for deleting the document.
type DeleteDocumentAction struct {
// Boolean field to select between hard vs soft delete options.
// Set 'true' for 'hard delete' and 'false' for 'soft delete'.
EnableHardDelete bool `protobuf:"varint,1,opt,name=enable_hard_delete,json=enableHardDelete,proto3" json:"enable_hard_delete,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDocumentAction) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDocumentAction.ProtoReflect.Descriptor instead.
func (x *DeleteDocumentAction) GetEnableHardDelete() bool
func (*DeleteDocumentAction) ProtoMessage()
func (x *DeleteDocumentAction) ProtoReflect() protoreflect.Message
func (x *DeleteDocumentAction) Reset()
func (x *DeleteDocumentAction) String() string
Request message for DocumentLinkService.DeleteDocumentLink.
type DeleteDocumentLinkRequest struct {
// Required. The name of the document-link to be deleted.
// Format:
// projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The meta information collected about the document creator, used to enforce
// access control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDocumentLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDocumentLinkRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDocumentLinkRequest) GetName() string
func (x *DeleteDocumentLinkRequest) GetRequestMetadata() *RequestMetadata
func (*DeleteDocumentLinkRequest) ProtoMessage()
func (x *DeleteDocumentLinkRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDocumentLinkRequest) Reset()
func (x *DeleteDocumentLinkRequest) String() string
Request message for DocumentService.DeleteDocument.
type DeleteDocumentRequest struct {
// Required. The name of the document to delete.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}
// or
// projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDocumentRequest) GetName() string
func (x *DeleteDocumentRequest) GetRequestMetadata() *RequestMetadata
func (*DeleteDocumentRequest) ProtoMessage()
func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDocumentRequest) Reset()
func (x *DeleteDocumentRequest) String() string
Request message for DocumentSchemaService.DeleteDocumentSchema.
type DeleteDocumentSchemaRequest struct {
// Required. The name of the document schema to delete.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDocumentSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDocumentSchemaRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDocumentSchemaRequest) GetName() string
func (*DeleteDocumentSchemaRequest) ProtoMessage()
func (x *DeleteDocumentSchemaRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDocumentSchemaRequest) Reset()
func (x *DeleteDocumentSchemaRequest) String() string
Request message for RuleSetService.DeleteRuleSet.
type DeleteRuleSetRequest struct {
// Required. The name of the rule set to delete.
// Format:
// projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteRuleSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteRuleSetRequest.ProtoReflect.Descriptor instead.
func (x *DeleteRuleSetRequest) GetName() string
func (*DeleteRuleSetRequest) ProtoMessage()
func (x *DeleteRuleSetRequest) ProtoReflect() protoreflect.Message
func (x *DeleteRuleSetRequest) Reset()
func (x *DeleteRuleSetRequest) String() string
Request message for SynonymSetService.DeleteSynonymSet.
type DeleteSynonymSetRequest struct {
// Required. The name of the synonymSet to delete
// Format:
// projects/{project_number}/locations/{location}/synonymSets/{context}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteSynonymSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSynonymSetRequest.ProtoReflect.Descriptor instead.
func (x *DeleteSynonymSetRequest) GetName() string
func (*DeleteSynonymSetRequest) ProtoMessage()
func (x *DeleteSynonymSetRequest) ProtoReflect() protoreflect.Message
func (x *DeleteSynonymSetRequest) Reset()
func (x *DeleteSynonymSetRequest) String() string
Defines the structure for content warehouse document proto.
type Document struct {
// The resource name of the document.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}.
//
// The name is ignored when creating a document.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The reference ID set by customers. Must be unique per project and location.
ReferenceId string `protobuf:"bytes,11,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
// Required. Display name of the document given by the user. This name will be displayed
// in the UI.
// Customer can populate this field with the name of the document. This
// differs from the 'title' field as 'title' is optional and stores the top
// heading in the document.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Title that describes the document.
// This is usually present in the top section of the document, and is a
// mandatory field for the question-answering feature.
Title string `protobuf:"bytes,18,opt,name=title,proto3" json:"title,omitempty"`
// Uri to display the document, for example, in the UI.
DisplayUri string `protobuf:"bytes,17,opt,name=display_uri,json=displayUri,proto3" json:"display_uri,omitempty"`
// The Document schema name.
// Format:
// projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
DocumentSchemaName string `protobuf:"bytes,3,opt,name=document_schema_name,json=documentSchemaName,proto3" json:"document_schema_name,omitempty"`
// Types that are assignable to StructuredContent:
//
// *Document_PlainText
// *Document_CloudAiDocument
StructuredContent isDocument_StructuredContent `protobuf_oneof:"structured_content"`
// A path linked to structured content file.
StructuredContentUri string `protobuf:"bytes,16,opt,name=structured_content_uri,json=structuredContentUri,proto3" json:"structured_content_uri,omitempty"`
// Raw document file.
//
// Types that are assignable to RawDocument:
//
// *Document_RawDocumentPath
// *Document_InlineRawDocument
RawDocument isDocument_RawDocument `protobuf_oneof:"raw_document"`
// List of values that are user supplied metadata.
Properties []*Property `protobuf:"bytes,7,rep,name=properties,proto3" json:"properties,omitempty"`
// Output only. The time when the document is last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time when the document is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// This is used when DocAI was not used to load the document and parsing/
// extracting is needed for the inline_raw_document. For example, if
// inline_raw_document is the byte representation of a PDF file, then
// this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
RawDocumentFileType RawDocumentFileType `protobuf:"varint,10,opt,name=raw_document_file_type,json=rawDocumentFileType,proto3,enum=google.cloud.contentwarehouse.v1.RawDocumentFileType" json:"raw_document_file_type,omitempty"`
// If true, makes the document visible to asynchronous policies and rules.
AsyncEnabled bool `protobuf:"varint,12,opt,name=async_enabled,json=asyncEnabled,proto3" json:"async_enabled,omitempty"`
// If true, text extraction will not be performed.
TextExtractionDisabled bool `protobuf:"varint,19,opt,name=text_extraction_disabled,json=textExtractionDisabled,proto3" json:"text_extraction_disabled,omitempty"`
// The user who creates the document.
Creator string `protobuf:"bytes,13,opt,name=creator,proto3" json:"creator,omitempty"`
// The user who lastly updates the document.
Updater string `protobuf:"bytes,14,opt,name=updater,proto3" json:"updater,omitempty"`
// contains filtered or unexported fields
}
func (*Document) Descriptor() ([]byte, []int)
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (x *Document) GetAsyncEnabled() bool
func (x *Document) GetCloudAiDocument() *v1.Document
func (x *Document) GetCreateTime() *timestamppb.Timestamp
func (x *Document) GetCreator() string
func (x *Document) GetDisplayName() string
func (x *Document) GetDisplayUri() string
func (x *Document) GetDocumentSchemaName() string
func (x *Document) GetInlineRawDocument() []byte
func (x *Document) GetName() string
func (x *Document) GetPlainText() string
func (x *Document) GetProperties() []*Property
func (m *Document) GetRawDocument() isDocument_RawDocument
func (x *Document) GetRawDocumentFileType() RawDocumentFileType
func (x *Document) GetRawDocumentPath() string
func (x *Document) GetReferenceId() string
func (m *Document) GetStructuredContent() isDocument_StructuredContent
func (x *Document) GetStructuredContentUri() string
func (x *Document) GetTextExtractionDisabled() bool
func (x *Document) GetTitle() string
func (x *Document) GetUpdateTime() *timestamppb.Timestamp
func (x *Document) GetUpdater() string
func (*Document) ProtoMessage()
func (x *Document) ProtoReflect() protoreflect.Message
func (x *Document) Reset()
func (x *Document) String() string
A document-link between source and target document.
type DocumentLink struct {
// Name of this document-link.
// It is required that the parent derived form the name to be consistent with
// the source document reference. Otherwise an exception will be thrown.
// Format:
// projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Document references of the source document.
SourceDocumentReference *DocumentReference `protobuf:"bytes,2,opt,name=source_document_reference,json=sourceDocumentReference,proto3" json:"source_document_reference,omitempty"`
// Document references of the target document.
TargetDocumentReference *DocumentReference `protobuf:"bytes,3,opt,name=target_document_reference,json=targetDocumentReference,proto3" json:"target_document_reference,omitempty"`
// Description of this document-link.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The time when the documentLink is last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time when the documentLink is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The state of the documentlink. If target node has been deleted, the
// link is marked as invalid. Removing a source node will result in removal
// of all associated links.
State DocumentLink_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.contentwarehouse.v1.DocumentLink_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentLink) Descriptor() ([]byte, []int)
Deprecated: Use DocumentLink.ProtoReflect.Descriptor instead.
func (x *DocumentLink) GetCreateTime() *timestamppb.Timestamp
func (x *DocumentLink) GetDescription() string
func (x *DocumentLink) GetName() string
func (x *DocumentLink) GetSourceDocumentReference() *DocumentReference
func (x *DocumentLink) GetState() DocumentLink_State
func (x *DocumentLink) GetTargetDocumentReference() *DocumentReference
func (x *DocumentLink) GetUpdateTime() *timestamppb.Timestamp
func (*DocumentLink) ProtoMessage()
func (x *DocumentLink) ProtoReflect() protoreflect.Message
func (x *DocumentLink) Reset()
func (x *DocumentLink) String() string
DocumentLinkServiceClient is the client API for DocumentLinkService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type DocumentLinkServiceClient interface {
// Return all target document-links from the document.
ListLinkedTargets(ctx context.Context, in *ListLinkedTargetsRequest, opts ...grpc.CallOption) (*ListLinkedTargetsResponse, error)
// Return all source document-links from the document.
ListLinkedSources(ctx context.Context, in *ListLinkedSourcesRequest, opts ...grpc.CallOption) (*ListLinkedSourcesResponse, error)
// Create a link between a source document and a target document.
CreateDocumentLink(ctx context.Context, in *CreateDocumentLinkRequest, opts ...grpc.CallOption) (*DocumentLink, error)
// Remove the link between the source and target documents.
DeleteDocumentLink(ctx context.Context, in *DeleteDocumentLinkRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
func NewDocumentLinkServiceClient(cc grpc.ClientConnInterface) DocumentLinkServiceClient
DocumentLinkServiceServer is the server API for DocumentLinkService service.
type DocumentLinkServiceServer interface {
// Return all target document-links from the document.
ListLinkedTargets(context.Context, *ListLinkedTargetsRequest) (*ListLinkedTargetsResponse, error)
// Return all source document-links from the document.
ListLinkedSources(context.Context, *ListLinkedSourcesRequest) (*ListLinkedSourcesResponse, error)
// Create a link between a source document and a target document.
CreateDocumentLink(context.Context, *CreateDocumentLinkRequest) (*DocumentLink, error)
// Remove the link between the source and target documents.
DeleteDocumentLink(context.Context, *DeleteDocumentLinkRequest) (*emptypb.Empty, error)
}
The state of a document-link.
type DocumentLink_State int32
const (
// Unknown state of documentlink.
DocumentLink_STATE_UNSPECIFIED DocumentLink_State = 0
// The documentlink has both source and target documents detected.
DocumentLink_ACTIVE DocumentLink_State = 1
// Target document is deleted, and mark the documentlink as soft-deleted.
DocumentLink_SOFT_DELETED DocumentLink_State = 2
)
func (DocumentLink_State) Descriptor() protoreflect.EnumDescriptor
func (x DocumentLink_State) Enum() *DocumentLink_State
func (DocumentLink_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use DocumentLink_State.Descriptor instead.
func (x DocumentLink_State) Number() protoreflect.EnumNumber
func (x DocumentLink_State) String() string
func (DocumentLink_State) Type() protoreflect.EnumType
type DocumentQuery struct {
// The query string that matches against the full text of the document and
// the searchable properties.
// The maximum number of allowed characters is 255.
Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
// Experimental, do not use.
// If the query is a natural language question. False by default. If true,
// then the question-answering feature will be used instead of search, and
// `result_count` in [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest] must be set. In addition, all
// other input fields related to search (pagination, histograms, etc.) will be
// ignored.
IsNlQuery bool `protobuf:"varint,12,opt,name=is_nl_query,json=isNlQuery,proto3" json:"is_nl_query,omitempty"`
// This filter specifies a structured syntax to match against the
// [PropertyDefinition].[is_filterable][] marked as `true`. The syntax for
// this expression is a subset of SQL syntax.
//
// Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left
// of the operator is a property name and the right of the operator is a
// number or a quoted string. You must escape backslash (\\) and quote (\")
// characters. Supported functions are `LOWER([property_name])` to perform a
// case insensitive match and `EMPTY([property_name])` to filter on the
// existence of a key.
//
// Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
// (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
// comparisons or functions are allowed in the expression. The expression must
// be < 6000 bytes in length.
//
// Sample Query:
// `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
// driving_years > 10`
//
// Deprecated: Do not use.
CustomPropertyFilter string `protobuf:"bytes,4,opt,name=custom_property_filter,json=customPropertyFilter,proto3" json:"custom_property_filter,omitempty"`
// Documents created/updated within a range specified by this filter are
// searched against.
TimeFilters []*TimeFilter `protobuf:"bytes,5,rep,name=time_filters,json=timeFilters,proto3" json:"time_filters,omitempty"`
// This filter specifies the exact document schema
// [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] of the documents to search against.
//
// If a value isn't specified, documents within the search results are
// associated with any schema. If multiple values are specified, documents
// within the search results may be associated with any of the specified
// schemas.
//
// At most 20 document schema names are allowed.
DocumentSchemaNames []string `protobuf:"bytes,6,rep,name=document_schema_names,json=documentSchemaNames,proto3" json:"document_schema_names,omitempty"`
// This filter specifies a structured syntax to match against the
// [PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable] marked as `true`. The relationship
// between the PropertyFilters is OR.
PropertyFilter []*PropertyFilter `protobuf:"bytes,7,rep,name=property_filter,json=propertyFilter,proto3" json:"property_filter,omitempty"`
// This filter specifies the types of files to return: ALL, FOLDER, or FILE.
// If FOLDER or FILE is specified, then only either folders or files will be
// returned, respectively. If ALL is specified, both folders and files will be
// returned.
//
// If no value is specified, ALL files will be returned.
FileTypeFilter *FileTypeFilter `protobuf:"bytes,8,opt,name=file_type_filter,json=fileTypeFilter,proto3" json:"file_type_filter,omitempty"`
// Search all the documents under this specified folder.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}.
FolderNameFilter string `protobuf:"bytes,9,opt,name=folder_name_filter,json=folderNameFilter,proto3" json:"folder_name_filter,omitempty"`
// For custom synonyms.
// Customers provide the synonyms based on context. One customer can provide
// multiple set of synonyms based on different context. The search query will
// be expanded based on the custom synonyms of the query context set.
// By default, no custom synonyms wll be applied if no query context is
// provided.
// It is not supported for CMEK compliant deployment.
QueryContext []string `protobuf:"bytes,10,rep,name=query_context,json=queryContext,proto3" json:"query_context,omitempty"`
// The exact creator(s) of the documents to search against.
//
// If a value isn't specified, documents within the search results are
// associated with any creator. If multiple values are specified, documents
// within the search results may be associated with any of the specified
// creators.
DocumentCreatorFilter []string `protobuf:"bytes,11,rep,name=document_creator_filter,json=documentCreatorFilter,proto3" json:"document_creator_filter,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentQuery) Descriptor() ([]byte, []int)
Deprecated: Use DocumentQuery.ProtoReflect.Descriptor instead.
func (x *DocumentQuery) GetCustomPropertyFilter() string
Deprecated: Do not use.
func (x *DocumentQuery) GetDocumentCreatorFilter() []string
func (x *DocumentQuery) GetDocumentSchemaNames() []string
func (x *DocumentQuery) GetFileTypeFilter() *FileTypeFilter
func (x *DocumentQuery) GetFolderNameFilter() string
func (x *DocumentQuery) GetIsNlQuery() bool
func (x *DocumentQuery) GetPropertyFilter() []*PropertyFilter
func (x *DocumentQuery) GetQuery() string
func (x *DocumentQuery) GetQueryContext() []string
func (x *DocumentQuery) GetTimeFilters() []*TimeFilter
func (*DocumentQuery) ProtoMessage()
func (x *DocumentQuery) ProtoReflect() protoreflect.Message
func (x *DocumentQuery) Reset()
func (x *DocumentQuery) String() string
References to the documents.
type DocumentReference struct {
// Required. Name of the referenced document.
DocumentName string `protobuf:"bytes,1,opt,name=document_name,json=documentName,proto3" json:"document_name,omitempty"`
// display_name of the referenced document; this name does not need to be
// consistent to the display_name in the Document proto, depending on the ACL
// constraint.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Stores the subset of the referenced document's content.
// This is useful to allow user peek the information of the referenced
// document.
Snippet string `protobuf:"bytes,3,opt,name=snippet,proto3" json:"snippet,omitempty"`
// The document type of the document being referenced.
DocumentIsFolder bool `protobuf:"varint,4,opt,name=document_is_folder,json=documentIsFolder,proto3" json:"document_is_folder,omitempty"`
// Output only. The time when the document is last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time when the document is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time when the document is deleted.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentReference) Descriptor() ([]byte, []int)
Deprecated: Use DocumentReference.ProtoReflect.Descriptor instead.
func (x *DocumentReference) GetCreateTime() *timestamppb.Timestamp
func (x *DocumentReference) GetDeleteTime() *timestamppb.Timestamp
func (x *DocumentReference) GetDisplayName() string
func (x *DocumentReference) GetDocumentIsFolder() bool
func (x *DocumentReference) GetDocumentName() string
func (x *DocumentReference) GetSnippet() string
func (x *DocumentReference) GetUpdateTime() *timestamppb.Timestamp
func (*DocumentReference) ProtoMessage()
func (x *DocumentReference) ProtoReflect() protoreflect.Message
func (x *DocumentReference) Reset()
func (x *DocumentReference) String() string
A document schema used to define document structure.
type DocumentSchema struct {
// The resource name of the document schema.
// Format:
// projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
//
// The name is ignored when creating a document schema.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Name of the schema given by the user. Must be unique per customer.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Document details.
PropertyDefinitions []*PropertyDefinition `protobuf:"bytes,3,rep,name=property_definitions,json=propertyDefinitions,proto3" json:"property_definitions,omitempty"`
// Document Type, true refers the document is a folder, otherwise it is
// a typical document.
DocumentIsFolder bool `protobuf:"varint,4,opt,name=document_is_folder,json=documentIsFolder,proto3" json:"document_is_folder,omitempty"`
// Output only. The time when the document schema is last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. The time when the document schema is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Schema description.
Description string `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentSchema) Descriptor() ([]byte, []int)
Deprecated: Use DocumentSchema.ProtoReflect.Descriptor instead.
func (x *DocumentSchema) GetCreateTime() *timestamppb.Timestamp
func (x *DocumentSchema) GetDescription() string
func (x *DocumentSchema) GetDisplayName() string
func (x *DocumentSchema) GetDocumentIsFolder() bool
func (x *DocumentSchema) GetName() string
func (x *DocumentSchema) GetPropertyDefinitions() []*PropertyDefinition
func (x *DocumentSchema) GetUpdateTime() *timestamppb.Timestamp
func (*DocumentSchema) ProtoMessage()
func (x *DocumentSchema) ProtoReflect() protoreflect.Message
func (x *DocumentSchema) Reset()
func (x *DocumentSchema) String() string
DocumentSchemaServiceClient is the client API for DocumentSchemaService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type DocumentSchemaServiceClient interface {
// Creates a document schema.
CreateDocumentSchema(ctx context.Context, in *CreateDocumentSchemaRequest, opts ...grpc.CallOption) (*DocumentSchema, error)
// Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the
// Document Schema is non-empty and does not equal the existing name.
// Supports only appending new properties, adding new ENUM possible values,
// and updating the [EnumTypeOptions.validation_check_disabled][google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled] flag for
// ENUM possible values. Updating existing properties will result into
// INVALID_ARGUMENT.
UpdateDocumentSchema(ctx context.Context, in *UpdateDocumentSchemaRequest, opts ...grpc.CallOption) (*DocumentSchema, error)
// Gets a document schema. Returns NOT_FOUND if the document schema does not
// exist.
GetDocumentSchema(ctx context.Context, in *GetDocumentSchemaRequest, opts ...grpc.CallOption) (*DocumentSchema, error)
// Deletes a document schema. Returns NOT_FOUND if the document schema does
// not exist. Returns BAD_REQUEST if the document schema has documents
// depending on it.
DeleteDocumentSchema(ctx context.Context, in *DeleteDocumentSchemaRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists document schemas.
ListDocumentSchemas(ctx context.Context, in *ListDocumentSchemasRequest, opts ...grpc.CallOption) (*ListDocumentSchemasResponse, error)
}
func NewDocumentSchemaServiceClient(cc grpc.ClientConnInterface) DocumentSchemaServiceClient
DocumentSchemaServiceServer is the server API for DocumentSchemaService service.
type DocumentSchemaServiceServer interface {
// Creates a document schema.
CreateDocumentSchema(context.Context, *CreateDocumentSchemaRequest) (*DocumentSchema, error)
// Updates a Document Schema. Returns INVALID_ARGUMENT if the name of the
// Document Schema is non-empty and does not equal the existing name.
// Supports only appending new properties, adding new ENUM possible values,
// and updating the [EnumTypeOptions.validation_check_disabled][google.cloud.contentwarehouse.v1.EnumTypeOptions.validation_check_disabled] flag for
// ENUM possible values. Updating existing properties will result into
// INVALID_ARGUMENT.
UpdateDocumentSchema(context.Context, *UpdateDocumentSchemaRequest) (*DocumentSchema, error)
// Gets a document schema. Returns NOT_FOUND if the document schema does not
// exist.
GetDocumentSchema(context.Context, *GetDocumentSchemaRequest) (*DocumentSchema, error)
// Deletes a document schema. Returns NOT_FOUND if the document schema does
// not exist. Returns BAD_REQUEST if the document schema has documents
// depending on it.
DeleteDocumentSchema(context.Context, *DeleteDocumentSchemaRequest) (*emptypb.Empty, error)
// Lists document schemas.
ListDocumentSchemas(context.Context, *ListDocumentSchemasRequest) (*ListDocumentSchemasResponse, error)
}
DocumentServiceClient is the client API for DocumentService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type DocumentServiceClient interface {
// Creates a document.
CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*CreateDocumentResponse, error)
// Gets a document. Returns NOT_FOUND if the document does not exist.
GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Updates a document. Returns INVALID_ARGUMENT if the name of the document
// is non-empty and does not equal the existing name.
UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*UpdateDocumentResponse, error)
// Deletes a document. Returns NOT_FOUND if the document does not exist.
DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Searches for documents using provided [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
// This call only returns documents that the caller has permission to search
// against.
SearchDocuments(ctx context.Context, in *SearchDocumentsRequest, opts ...grpc.CallOption) (*SearchDocumentsResponse, error)
// Gets the access control policy for a resource. Returns NOT_FOUND error if
// the resource does not exist. Returns an empty policy if the resource exists
// but does not have a policy set.
FetchAcl(ctx context.Context, in *FetchAclRequest, opts ...grpc.CallOption) (*FetchAclResponse, error)
// Sets the access control policy for a resource. Replaces any existing
// policy.
SetAcl(ctx context.Context, in *SetAclRequest, opts ...grpc.CallOption) (*SetAclResponse, error)
}
func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient
DocumentServiceServer is the server API for DocumentService service.
type DocumentServiceServer interface {
// Creates a document.
CreateDocument(context.Context, *CreateDocumentRequest) (*CreateDocumentResponse, error)
// Gets a document. Returns NOT_FOUND if the document does not exist.
GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
// Updates a document. Returns INVALID_ARGUMENT if the name of the document
// is non-empty and does not equal the existing name.
UpdateDocument(context.Context, *UpdateDocumentRequest) (*UpdateDocumentResponse, error)
// Deletes a document. Returns NOT_FOUND if the document does not exist.
DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
// Searches for documents using provided [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
// This call only returns documents that the caller has permission to search
// against.
SearchDocuments(context.Context, *SearchDocumentsRequest) (*SearchDocumentsResponse, error)
// Gets the access control policy for a resource. Returns NOT_FOUND error if
// the resource does not exist. Returns an empty policy if the resource exists
// but does not have a policy set.
FetchAcl(context.Context, *FetchAclRequest) (*FetchAclResponse, error)
// Sets the access control policy for a resource. Replaces any existing
// policy.
SetAcl(context.Context, *SetAclRequest) (*SetAclResponse, error)
}
type Document_CloudAiDocument struct {
// Document AI format to save the structured content, including OCR.
CloudAiDocument *v1.Document `protobuf:"bytes,4,opt,name=cloud_ai_document,json=cloudAiDocument,proto3,oneof"`
}
type Document_InlineRawDocument struct {
// Raw document content.
InlineRawDocument []byte `protobuf:"bytes,6,opt,name=inline_raw_document,json=inlineRawDocument,proto3,oneof"`
}
type Document_PlainText struct {
// Other document format, such as PPTX, XLXS
PlainText string `protobuf:"bytes,15,opt,name=plain_text,json=plainText,proto3,oneof"`
}
type Document_RawDocumentPath struct {
// Raw document file in Cloud Storage path.
RawDocumentPath string `protobuf:"bytes,5,opt,name=raw_document_path,json=rawDocumentPath,proto3,oneof"`
}
Enum values.
type EnumArray struct {
// List of enum values.
Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*EnumArray) Descriptor() ([]byte, []int)
Deprecated: Use EnumArray.ProtoReflect.Descriptor instead.
func (x *EnumArray) GetValues() []string
func (*EnumArray) ProtoMessage()
func (x *EnumArray) ProtoReflect() protoreflect.Message
func (x *EnumArray) Reset()
func (x *EnumArray) String() string
Configurations for an enum/categorical property.
type EnumTypeOptions struct {
// Required. List of possible enum values.
PossibleValues []string `protobuf:"bytes,1,rep,name=possible_values,json=possibleValues,proto3" json:"possible_values,omitempty"`
// Make sure the Enum property value provided in the document is in the
// possile value list during document creation. The validation check runs by
// default.
ValidationCheckDisabled bool `protobuf:"varint,2,opt,name=validation_check_disabled,json=validationCheckDisabled,proto3" json:"validation_check_disabled,omitempty"`
// contains filtered or unexported fields
}
func (*EnumTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use EnumTypeOptions.ProtoReflect.Descriptor instead.
func (x *EnumTypeOptions) GetPossibleValues() []string
func (x *EnumTypeOptions) GetValidationCheckDisabled() bool
func (*EnumTypeOptions) ProtoMessage()
func (x *EnumTypeOptions) ProtoReflect() protoreflect.Message
func (x *EnumTypeOptions) Reset()
func (x *EnumTypeOptions) String() string
Represents the string value of the enum field.
type EnumValue struct {
// String value of the enum field. This must match defined set of enums
// in document schema using EnumTypeOptions.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*EnumValue) Descriptor() ([]byte, []int)
Deprecated: Use EnumValue.ProtoReflect.Descriptor instead.
func (x *EnumValue) GetValue() string
func (*EnumValue) ProtoMessage()
func (x *EnumValue) ProtoReflect() protoreflect.Message
func (x *EnumValue) Reset()
func (x *EnumValue) String() string
Request message for DocumentService.FetchAcl
type FetchAclRequest struct {
// Required. REQUIRED: The resource for which the policy is being requested.
// Format for document:
// projects/{project_number}/locations/{location}/documents/{document_id}.
// Format for project: projects/{project_number}.
Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// For Get Project ACL only. Authorization check for end user will be ignored
// when project_owner=true.
ProjectOwner bool `protobuf:"varint,3,opt,name=project_owner,json=projectOwner,proto3" json:"project_owner,omitempty"`
// contains filtered or unexported fields
}
func (*FetchAclRequest) Descriptor() ([]byte, []int)
Deprecated: Use FetchAclRequest.ProtoReflect.Descriptor instead.
func (x *FetchAclRequest) GetProjectOwner() bool
func (x *FetchAclRequest) GetRequestMetadata() *RequestMetadata
func (x *FetchAclRequest) GetResource() string
func (*FetchAclRequest) ProtoMessage()
func (x *FetchAclRequest) ProtoReflect() protoreflect.Message
func (x *FetchAclRequest) Reset()
func (x *FetchAclRequest) String() string
Response message for DocumentService.FetchAcl.
type FetchAclResponse struct {
// The IAM policy.
Policy *v1.Policy `protobuf:"bytes,1,opt,name=policy,proto3" json:"policy,omitempty"`
// Additional information for the API invocation, such as the request tracking
// id.
Metadata *ResponseMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
func (*FetchAclResponse) Descriptor() ([]byte, []int)
Deprecated: Use FetchAclResponse.ProtoReflect.Descriptor instead.
func (x *FetchAclResponse) GetMetadata() *ResponseMetadata
func (x *FetchAclResponse) GetPolicy() *v1.Policy
func (*FetchAclResponse) ProtoMessage()
func (x *FetchAclResponse) ProtoReflect() protoreflect.Message
func (x *FetchAclResponse) Reset()
func (x *FetchAclResponse) String() string
Filter for the specific types of documents returned.
type FileTypeFilter struct {
// The type of files to return.
FileType FileTypeFilter_FileType `protobuf:"varint,1,opt,name=file_type,json=fileType,proto3,enum=google.cloud.contentwarehouse.v1.FileTypeFilter_FileType" json:"file_type,omitempty"`
// contains filtered or unexported fields
}
func (*FileTypeFilter) Descriptor() ([]byte, []int)
Deprecated: Use FileTypeFilter.ProtoReflect.Descriptor instead.
func (x *FileTypeFilter) GetFileType() FileTypeFilter_FileType
func (*FileTypeFilter) ProtoMessage()
func (x *FileTypeFilter) ProtoReflect() protoreflect.Message
func (x *FileTypeFilter) Reset()
func (x *FileTypeFilter) String() string
Representation of the types of files.
type FileTypeFilter_FileType int32
const (
// Default document type. If set, disables the filter.
FileTypeFilter_FILE_TYPE_UNSPECIFIED FileTypeFilter_FileType = 0
// Returns all document types, including folders.
FileTypeFilter_ALL FileTypeFilter_FileType = 1
// Returns only folders.
FileTypeFilter_FOLDER FileTypeFilter_FileType = 2
// Returns only non-folder documents.
FileTypeFilter_DOCUMENT FileTypeFilter_FileType = 3
)
func (FileTypeFilter_FileType) Descriptor() protoreflect.EnumDescriptor
func (x FileTypeFilter_FileType) Enum() *FileTypeFilter_FileType
func (FileTypeFilter_FileType) EnumDescriptor() ([]byte, []int)
Deprecated: Use FileTypeFilter_FileType.Descriptor instead.
func (x FileTypeFilter_FileType) Number() protoreflect.EnumNumber
func (x FileTypeFilter_FileType) String() string
func (FileTypeFilter_FileType) Type() protoreflect.EnumType
Float values.
type FloatArray struct {
// List of float values.
Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*FloatArray) Descriptor() ([]byte, []int)
Deprecated: Use FloatArray.ProtoReflect.Descriptor instead.
func (x *FloatArray) GetValues() []float32
func (*FloatArray) ProtoMessage()
func (x *FloatArray) ProtoReflect() protoreflect.Message
func (x *FloatArray) Reset()
func (x *FloatArray) String() string
Configurations for a float property.
type FloatTypeOptions struct {
// contains filtered or unexported fields
}
func (*FloatTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use FloatTypeOptions.ProtoReflect.Descriptor instead.
func (*FloatTypeOptions) ProtoMessage()
func (x *FloatTypeOptions) ProtoReflect() protoreflect.Message
func (x *FloatTypeOptions) Reset()
func (x *FloatTypeOptions) String() string
Request message for DocumentService.GetDocument.
type GetDocumentRequest struct {
// Required. The name of the document to retrieve.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id} or
// projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*GetDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.
func (x *GetDocumentRequest) GetName() string
func (x *GetDocumentRequest) GetRequestMetadata() *RequestMetadata
func (*GetDocumentRequest) ProtoMessage()
func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message
func (x *GetDocumentRequest) Reset()
func (x *GetDocumentRequest) String() string
Request message for DocumentSchemaService.GetDocumentSchema.
type GetDocumentSchemaRequest struct {
// Required. The name of the document schema to retrieve.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetDocumentSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDocumentSchemaRequest.ProtoReflect.Descriptor instead.
func (x *GetDocumentSchemaRequest) GetName() string
func (*GetDocumentSchemaRequest) ProtoMessage()
func (x *GetDocumentSchemaRequest) ProtoReflect() protoreflect.Message
func (x *GetDocumentSchemaRequest) Reset()
func (x *GetDocumentSchemaRequest) String() string
Request message for RuleSetService.GetRuleSet.
type GetRuleSetRequest struct {
// Required. The name of the rule set to retrieve.
// Format:
// projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetRuleSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRuleSetRequest.ProtoReflect.Descriptor instead.
func (x *GetRuleSetRequest) GetName() string
func (*GetRuleSetRequest) ProtoMessage()
func (x *GetRuleSetRequest) ProtoReflect() protoreflect.Message
func (x *GetRuleSetRequest) Reset()
func (x *GetRuleSetRequest) String() string
Request message for SynonymSetService.GetSynonymSet. Will return synonymSet for a certain context.
type GetSynonymSetRequest struct {
// Required. The name of the synonymSet to retrieve
// Format:
// projects/{project_number}/locations/{location}/synonymSets/{context}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSynonymSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSynonymSetRequest.ProtoReflect.Descriptor instead.
func (x *GetSynonymSetRequest) GetName() string
func (*GetSynonymSetRequest) ProtoMessage()
func (x *GetSynonymSetRequest) ProtoReflect() protoreflect.Message
func (x *GetSynonymSetRequest) Reset()
func (x *GetSynonymSetRequest) String() string
The histogram request.
type HistogramQuery struct {
// An expression specifies a histogram request against matching documents for
// searches.
//
// See [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries] for details about syntax.
HistogramQuery string `protobuf:"bytes,1,opt,name=histogram_query,json=histogramQuery,proto3" json:"histogram_query,omitempty"`
// Controls if the histogram query requires the return of a precise count.
// Enable this flag may adversely impact performance.
//
// Defaults to true.
RequirePreciseResultSize bool `protobuf:"varint,2,opt,name=require_precise_result_size,json=requirePreciseResultSize,proto3" json:"require_precise_result_size,omitempty"`
// Optional. Filter the result of histogram query by the property names. It only works
// with histogram query count('FilterableProperties').
// It is an optional. It will perform histogram on all the property names for
// all the document schemas. Setting this field will have a better
// performance.
Filters *HistogramQueryPropertyNameFilter `protobuf:"bytes,3,opt,name=filters,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}
func (*HistogramQuery) Descriptor() ([]byte, []int)
Deprecated: Use HistogramQuery.ProtoReflect.Descriptor instead.
func (x *HistogramQuery) GetFilters() *HistogramQueryPropertyNameFilter
func (x *HistogramQuery) GetHistogramQuery() string
func (x *HistogramQuery) GetRequirePreciseResultSize() bool
func (*HistogramQuery) ProtoMessage()
func (x *HistogramQuery) ProtoReflect() protoreflect.Message
func (x *HistogramQuery) Reset()
func (x *HistogramQuery) String() string
type HistogramQueryPropertyNameFilter struct {
// This filter specifies the exact document schema(s)
// [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name] to run histogram query against.
// It is optional. It will perform histogram for property names for all the
// document schemas if it is not set.
//
// At most 10 document schema names are allowed.
// Format:
// projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
DocumentSchemas []string `protobuf:"bytes,1,rep,name=document_schemas,json=documentSchemas,proto3" json:"document_schemas,omitempty"`
// It is optional. It will perform histogram for all the property names if it
// is not set.
// The properties need to be defined with the is_filterable flag set to
// true and the name of the property should be in the format:
// "schemaId.propertyName". The property needs to be defined in the schema.
// Example: the schema id is abc. Then the name of property for property
// MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
PropertyNames []string `protobuf:"bytes,2,rep,name=property_names,json=propertyNames,proto3" json:"property_names,omitempty"`
// By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not
// set.
YAxis HistogramQueryPropertyNameFilter_HistogramYAxis `protobuf:"varint,3,opt,name=y_axis,json=yAxis,proto3,enum=google.cloud.contentwarehouse.v1.HistogramQueryPropertyNameFilter_HistogramYAxis" json:"y_axis,omitempty"`
// contains filtered or unexported fields
}
func (*HistogramQueryPropertyNameFilter) Descriptor() ([]byte, []int)
Deprecated: Use HistogramQueryPropertyNameFilter.ProtoReflect.Descriptor instead.
func (x *HistogramQueryPropertyNameFilter) GetDocumentSchemas() []string
func (x *HistogramQueryPropertyNameFilter) GetPropertyNames() []string
func (x *HistogramQueryPropertyNameFilter) GetYAxis() HistogramQueryPropertyNameFilter_HistogramYAxis
func (*HistogramQueryPropertyNameFilter) ProtoMessage()
func (x *HistogramQueryPropertyNameFilter) ProtoReflect() protoreflect.Message
func (x *HistogramQueryPropertyNameFilter) Reset()
func (x *HistogramQueryPropertyNameFilter) String() string
The result of the histogram query count('FilterableProperties') using HISTOGRAM_YAXIS_DOCUMENT will be: invoice_id: 2 address: 1 payment_method: 2 line_item_description: 1
type HistogramQueryPropertyNameFilter_HistogramYAxis int32
const (
// Count the documents per property name.
HistogramQueryPropertyNameFilter_HISTOGRAM_YAXIS_DOCUMENT HistogramQueryPropertyNameFilter_HistogramYAxis = 0
// Count the properties per property name.
HistogramQueryPropertyNameFilter_HISTOGRAM_YAXIS_PROPERTY HistogramQueryPropertyNameFilter_HistogramYAxis = 1
)
func (HistogramQueryPropertyNameFilter_HistogramYAxis) Descriptor() protoreflect.EnumDescriptor
func (x HistogramQueryPropertyNameFilter_HistogramYAxis) Enum() *HistogramQueryPropertyNameFilter_HistogramYAxis
func (HistogramQueryPropertyNameFilter_HistogramYAxis) EnumDescriptor() ([]byte, []int)
Deprecated: Use HistogramQueryPropertyNameFilter_HistogramYAxis.Descriptor instead.
func (x HistogramQueryPropertyNameFilter_HistogramYAxis) Number() protoreflect.EnumNumber
func (x HistogramQueryPropertyNameFilter_HistogramYAxis) String() string
func (HistogramQueryPropertyNameFilter_HistogramYAxis) Type() protoreflect.EnumType
Histogram result that matches HistogramQuery[google.cloud.contentwarehouse.v1.HistogramQuery] specified in searches.
type HistogramQueryResult struct {
// Requested histogram expression.
HistogramQuery string `protobuf:"bytes,1,opt,name=histogram_query,json=histogramQuery,proto3" json:"histogram_query,omitempty"`
// A map from the values of the facet associated with distinct values to the
// number of matching entries with corresponding value.
//
// The key format is:
//
// * (for string histogram) string values stored in the field.
Histogram map[string]int64 `protobuf:"bytes,2,rep,name=histogram,proto3" json:"histogram,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"varint,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*HistogramQueryResult) Descriptor() ([]byte, []int)
Deprecated: Use HistogramQueryResult.ProtoReflect.Descriptor instead.
func (x *HistogramQueryResult) GetHistogram() map[string]int64
func (x *HistogramQueryResult) GetHistogramQuery() string
func (*HistogramQueryResult) ProtoMessage()
func (x *HistogramQueryResult) ProtoReflect() protoreflect.Message
func (x *HistogramQueryResult) Reset()
func (x *HistogramQueryResult) String() string
Integer values.
type IntegerArray struct {
// List of integer values.
Values []int32 `protobuf:"varint,1,rep,packed,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*IntegerArray) Descriptor() ([]byte, []int)
Deprecated: Use IntegerArray.ProtoReflect.Descriptor instead.
func (x *IntegerArray) GetValues() []int32
func (*IntegerArray) ProtoMessage()
func (x *IntegerArray) ProtoReflect() protoreflect.Message
func (x *IntegerArray) Reset()
func (x *IntegerArray) String() string
Configurations for an integer property.
type IntegerTypeOptions struct {
// contains filtered or unexported fields
}
func (*IntegerTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use IntegerTypeOptions.ProtoReflect.Descriptor instead.
func (*IntegerTypeOptions) ProtoMessage()
func (x *IntegerTypeOptions) ProtoReflect() protoreflect.Message
func (x *IntegerTypeOptions) Reset()
func (x *IntegerTypeOptions) String() string
A triggered rule that failed the validation check(s) after parsing.
type InvalidRule struct {
// Triggered rule.
Rule *Rule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"`
// Validation error on a parsed expression.
Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
// contains filtered or unexported fields
}
func (*InvalidRule) Descriptor() ([]byte, []int)
Deprecated: Use InvalidRule.ProtoReflect.Descriptor instead.
func (x *InvalidRule) GetError() string
func (x *InvalidRule) GetRule() *Rule
func (*InvalidRule) ProtoMessage()
func (x *InvalidRule) ProtoReflect() protoreflect.Message
func (x *InvalidRule) Reset()
func (x *InvalidRule) String() string
Request message for DocumentSchemaService.ListDocumentSchemas.
type ListDocumentSchemasRequest struct {
// Required. The parent, which owns this collection of document schemas.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of document schemas to return. The service may return
// fewer than this value.
// If unspecified, at most 50 document schemas will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListDocumentSchemas` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListDocumentSchemas`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDocumentSchemasRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDocumentSchemasRequest.ProtoReflect.Descriptor instead.
func (x *ListDocumentSchemasRequest) GetPageSize() int32
func (x *ListDocumentSchemasRequest) GetPageToken() string
func (x *ListDocumentSchemasRequest) GetParent() string
func (*ListDocumentSchemasRequest) ProtoMessage()
func (x *ListDocumentSchemasRequest) ProtoReflect() protoreflect.Message
func (x *ListDocumentSchemasRequest) Reset()
func (x *ListDocumentSchemasRequest) String() string
Response message for DocumentSchemaService.ListDocumentSchemas.
type ListDocumentSchemasResponse struct {
// The document schemas from the specified parent.
DocumentSchemas []*DocumentSchema `protobuf:"bytes,1,rep,name=document_schemas,json=documentSchemas,proto3" json:"document_schemas,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDocumentSchemasResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDocumentSchemasResponse.ProtoReflect.Descriptor instead.
func (x *ListDocumentSchemasResponse) GetDocumentSchemas() []*DocumentSchema
func (x *ListDocumentSchemasResponse) GetNextPageToken() string
func (*ListDocumentSchemasResponse) ProtoMessage()
func (x *ListDocumentSchemasResponse) ProtoReflect() protoreflect.Message
func (x *ListDocumentSchemasResponse) Reset()
func (x *ListDocumentSchemasResponse) String() string
Response message for DocumentLinkService.ListLinkedSources.
type ListLinkedSourcesRequest struct {
// Required. The name of the document, for which all source links are returned.
// Format:
// projects/{project_number}/locations/{location}/documents/{source_document_id}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of document-links to return. The service may return
// fewer than this value.
//
// If unspecified, at most 50 document-links will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListLinkedSources` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListLinkedSources`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// The meta information collected about the document creator, used to enforce
// access control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*ListLinkedSourcesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLinkedSourcesRequest.ProtoReflect.Descriptor instead.
func (x *ListLinkedSourcesRequest) GetPageSize() int32
func (x *ListLinkedSourcesRequest) GetPageToken() string
func (x *ListLinkedSourcesRequest) GetParent() string
func (x *ListLinkedSourcesRequest) GetRequestMetadata() *RequestMetadata
func (*ListLinkedSourcesRequest) ProtoMessage()
func (x *ListLinkedSourcesRequest) ProtoReflect() protoreflect.Message
func (x *ListLinkedSourcesRequest) Reset()
func (x *ListLinkedSourcesRequest) String() string
Response message for DocumentLinkService.ListLinkedSources.
type ListLinkedSourcesResponse struct {
// Source document-links.
DocumentLinks []*DocumentLink `protobuf:"bytes,1,rep,name=document_links,json=documentLinks,proto3" json:"document_links,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLinkedSourcesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLinkedSourcesResponse.ProtoReflect.Descriptor instead.
func (x *ListLinkedSourcesResponse) GetDocumentLinks() []*DocumentLink
func (x *ListLinkedSourcesResponse) GetNextPageToken() string
func (*ListLinkedSourcesResponse) ProtoMessage()
func (x *ListLinkedSourcesResponse) ProtoReflect() protoreflect.Message
func (x *ListLinkedSourcesResponse) Reset()
func (x *ListLinkedSourcesResponse) String() string
Request message for DocumentLinkService.ListLinkedTargets.
type ListLinkedTargetsRequest struct {
// Required. The name of the document, for which all target links are returned.
// Format:
// projects/{project_number}/locations/{location}/documents/{target_document_id}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The meta information collected about the document creator, used to enforce
// access control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,2,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// contains filtered or unexported fields
}
func (*ListLinkedTargetsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListLinkedTargetsRequest.ProtoReflect.Descriptor instead.
func (x *ListLinkedTargetsRequest) GetParent() string
func (x *ListLinkedTargetsRequest) GetRequestMetadata() *RequestMetadata
func (*ListLinkedTargetsRequest) ProtoMessage()
func (x *ListLinkedTargetsRequest) ProtoReflect() protoreflect.Message
func (x *ListLinkedTargetsRequest) Reset()
func (x *ListLinkedTargetsRequest) String() string
Response message for DocumentLinkService.ListLinkedTargets.
type ListLinkedTargetsResponse struct {
// Target document-links.
DocumentLinks []*DocumentLink `protobuf:"bytes,1,rep,name=document_links,json=documentLinks,proto3" json:"document_links,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListLinkedTargetsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListLinkedTargetsResponse.ProtoReflect.Descriptor instead.
func (x *ListLinkedTargetsResponse) GetDocumentLinks() []*DocumentLink
func (x *ListLinkedTargetsResponse) GetNextPageToken() string
func (*ListLinkedTargetsResponse) ProtoMessage()
func (x *ListLinkedTargetsResponse) ProtoReflect() protoreflect.Message
func (x *ListLinkedTargetsResponse) Reset()
func (x *ListLinkedTargetsResponse) String() string
Request message for RuleSetService.ListRuleSets.
type ListRuleSetsRequest struct {
// Required. The parent, which owns this collection of document.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of rule sets to return. The service may return
// fewer than this value.
// If unspecified, at most 50 rule sets will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListRuleSets` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListRuleSets`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListRuleSetsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRuleSetsRequest.ProtoReflect.Descriptor instead.
func (x *ListRuleSetsRequest) GetPageSize() int32
func (x *ListRuleSetsRequest) GetPageToken() string
func (x *ListRuleSetsRequest) GetParent() string
func (*ListRuleSetsRequest) ProtoMessage()
func (x *ListRuleSetsRequest) ProtoReflect() protoreflect.Message
func (x *ListRuleSetsRequest) Reset()
func (x *ListRuleSetsRequest) String() string
Response message for RuleSetService.ListRuleSets.
type ListRuleSetsResponse struct {
// The rule sets from the specified parent.
RuleSets []*RuleSet `protobuf:"bytes,1,rep,name=rule_sets,json=ruleSets,proto3" json:"rule_sets,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListRuleSetsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRuleSetsResponse.ProtoReflect.Descriptor instead.
func (x *ListRuleSetsResponse) GetNextPageToken() string
func (x *ListRuleSetsResponse) GetRuleSets() []*RuleSet
func (*ListRuleSetsResponse) ProtoMessage()
func (x *ListRuleSetsResponse) ProtoReflect() protoreflect.Message
func (x *ListRuleSetsResponse) Reset()
func (x *ListRuleSetsResponse) String() string
Request message for SynonymSetService.ListSynonymSets. Will return all synonymSets belonging to the customer project.
type ListSynonymSetsRequest struct {
// Required. The parent name.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of synonymSets to return. The service may return
// fewer than this value.
// If unspecified, at most 50 rule sets will be returned.
// The maximum value is 1000; values above 1000 will be coerced to 1000.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListSynonymSets` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListSynonymSets`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSynonymSetsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSynonymSetsRequest.ProtoReflect.Descriptor instead.
func (x *ListSynonymSetsRequest) GetPageSize() int32
func (x *ListSynonymSetsRequest) GetPageToken() string
func (x *ListSynonymSetsRequest) GetParent() string
func (*ListSynonymSetsRequest) ProtoMessage()
func (x *ListSynonymSetsRequest) ProtoReflect() protoreflect.Message
func (x *ListSynonymSetsRequest) Reset()
func (x *ListSynonymSetsRequest) String() string
Response message for SynonymSetService.ListSynonymSets.
type ListSynonymSetsResponse struct {
// The synonymSets from the specified parent.
SynonymSets []*SynonymSet `protobuf:"bytes,1,rep,name=synonym_sets,json=synonymSets,proto3" json:"synonym_sets,omitempty"`
// A page token, received from a previous `ListSynonymSets` call.
// Provide this to retrieve the subsequent page.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSynonymSetsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSynonymSetsResponse.ProtoReflect.Descriptor instead.
func (x *ListSynonymSetsResponse) GetNextPageToken() string
func (x *ListSynonymSetsResponse) GetSynonymSets() []*SynonymSet
func (*ListSynonymSetsResponse) ProtoMessage()
func (x *ListSynonymSetsResponse) ProtoReflect() protoreflect.Message
func (x *ListSynonymSetsResponse) Reset()
func (x *ListSynonymSetsResponse) String() string
Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values.
type MapProperty struct {
// Unordered map of dynamically typed values.
Fields map[string]*Value `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*MapProperty) Descriptor() ([]byte, []int)
Deprecated: Use MapProperty.ProtoReflect.Descriptor instead.
func (x *MapProperty) GetFields() map[string]*Value
func (*MapProperty) ProtoMessage()
func (x *MapProperty) ProtoReflect() protoreflect.Message
func (x *MapProperty) Reset()
func (x *MapProperty) String() string
Configurations for a Map property.
type MapTypeOptions struct {
// contains filtered or unexported fields
}
func (*MapTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use MapTypeOptions.ProtoReflect.Descriptor instead.
func (*MapTypeOptions) ProtoMessage()
func (x *MapTypeOptions) ProtoReflect() protoreflect.Message
func (x *MapTypeOptions) Reset()
func (x *MapTypeOptions) String() string
Options for merging updated fields.
type MergeFieldsOptions struct {
// When merging message fields, the default behavior is to merge
// the content of two message fields together. If you instead want to use
// the field from the source message to replace the corresponding field in
// the destination message, set this flag to true. When this flag is set,
// specified submessage fields that are missing in source will be cleared in
// destination.
ReplaceMessageFields *bool `protobuf:"varint,1,opt,name=replace_message_fields,json=replaceMessageFields,proto3,oneof" json:"replace_message_fields,omitempty"`
// When merging repeated fields, the default behavior is to append
// entries from the source repeated field to the destination repeated field.
// If you instead want to keep only the entries from the source repeated
// field, set this flag to true.
//
// If you want to replace a repeated field within a message field on the
// destination message, you must set both replace_repeated_fields and
// replace_message_fields to true, otherwise the repeated fields will be
// appended.
ReplaceRepeatedFields *bool `protobuf:"varint,2,opt,name=replace_repeated_fields,json=replaceRepeatedFields,proto3,oneof" json:"replace_repeated_fields,omitempty"`
// contains filtered or unexported fields
}
func (*MergeFieldsOptions) Descriptor() ([]byte, []int)
Deprecated: Use MergeFieldsOptions.ProtoReflect.Descriptor instead.
func (x *MergeFieldsOptions) GetReplaceMessageFields() bool
func (x *MergeFieldsOptions) GetReplaceRepeatedFields() bool
func (*MergeFieldsOptions) ProtoMessage()
func (x *MergeFieldsOptions) ProtoReflect() protoreflect.Message
func (x *MergeFieldsOptions) Reset()
func (x *MergeFieldsOptions) String() string
Property of a document.
type Property struct {
// Required. Must match the name of a PropertyDefinition in the DocumentSchema.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Type of the property.
// Must match the property_options type of the matching PropertyDefinition.
// Value of the Property parsed into a specific data type.
// Specific type value(s) obtained from Document AIs Property.mention_text
// field.
//
// Types that are assignable to Values:
//
// *Property_IntegerValues
// *Property_FloatValues
// *Property_TextValues
// *Property_EnumValues
// *Property_PropertyValues
// *Property_DateTimeValues
// *Property_MapProperty
// *Property_TimestampValues
Values isProperty_Values `protobuf_oneof:"values"`
// contains filtered or unexported fields
}
func (*Property) Descriptor() ([]byte, []int)
Deprecated: Use Property.ProtoReflect.Descriptor instead.
func (x *Property) GetDateTimeValues() *DateTimeArray
func (x *Property) GetEnumValues() *EnumArray
func (x *Property) GetFloatValues() *FloatArray
func (x *Property) GetIntegerValues() *IntegerArray
func (x *Property) GetMapProperty() *MapProperty
func (x *Property) GetName() string
func (x *Property) GetPropertyValues() *PropertyArray
func (x *Property) GetTextValues() *TextArray
func (x *Property) GetTimestampValues() *TimestampArray
func (m *Property) GetValues() isProperty_Values
func (*Property) ProtoMessage()
func (x *Property) ProtoReflect() protoreflect.Message
func (x *Property) Reset()
func (x *Property) String() string
Property values.
type PropertyArray struct {
// List of property values.
Properties []*Property `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyArray) Descriptor() ([]byte, []int)
Deprecated: Use PropertyArray.ProtoReflect.Descriptor instead.
func (x *PropertyArray) GetProperties() []*Property
func (*PropertyArray) ProtoMessage()
func (x *PropertyArray) ProtoReflect() protoreflect.Message
func (x *PropertyArray) Reset()
func (x *PropertyArray) String() string
Defines the metadata for a schema property.
type PropertyDefinition struct {
// Required. The name of the metadata property.
// Must be unique within a document schema and is case insensitive.
// Names must be non-blank, start with a letter, and can contain alphanumeric
// characters and: /, :, -, _, and .
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The display-name for the property, used for front-end.
DisplayName string `protobuf:"bytes,12,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Whether the property can have multiple values.
IsRepeatable bool `protobuf:"varint,2,opt,name=is_repeatable,json=isRepeatable,proto3" json:"is_repeatable,omitempty"`
// Whether the property can be filtered. If this is a sub-property, all the
// parent properties must be marked filterable.
IsFilterable bool `protobuf:"varint,3,opt,name=is_filterable,json=isFilterable,proto3" json:"is_filterable,omitempty"`
// Indicates that the property should be included in a global search.
IsSearchable bool `protobuf:"varint,4,opt,name=is_searchable,json=isSearchable,proto3" json:"is_searchable,omitempty"`
// Whether the property is user supplied metadata.
IsMetadata bool `protobuf:"varint,5,opt,name=is_metadata,json=isMetadata,proto3" json:"is_metadata,omitempty"`
// Whether the property is mandatory.
// Default is 'false', i.e. populating property value can be skipped.
// If 'true' then user must populate the value for this property.
IsRequired bool `protobuf:"varint,14,opt,name=is_required,json=isRequired,proto3" json:"is_required,omitempty"`
// Type of the property.
//
// Types that are assignable to ValueTypeOptions:
//
// *PropertyDefinition_IntegerTypeOptions
// *PropertyDefinition_FloatTypeOptions
// *PropertyDefinition_TextTypeOptions
// *PropertyDefinition_PropertyTypeOptions
// *PropertyDefinition_EnumTypeOptions
// *PropertyDefinition_DateTimeTypeOptions
// *PropertyDefinition_MapTypeOptions
// *PropertyDefinition_TimestampTypeOptions
ValueTypeOptions isPropertyDefinition_ValueTypeOptions `protobuf_oneof:"value_type_options"`
// contains filtered or unexported fields
}
func (*PropertyDefinition) Descriptor() ([]byte, []int)
Deprecated: Use PropertyDefinition.ProtoReflect.Descriptor instead.
func (x *PropertyDefinition) GetDateTimeTypeOptions() *DateTimeTypeOptions
func (x *PropertyDefinition) GetDisplayName() string
func (x *PropertyDefinition) GetEnumTypeOptions() *EnumTypeOptions
func (x *PropertyDefinition) GetFloatTypeOptions() *FloatTypeOptions
func (x *PropertyDefinition) GetIntegerTypeOptions() *IntegerTypeOptions
func (x *PropertyDefinition) GetIsFilterable() bool
func (x *PropertyDefinition) GetIsMetadata() bool
func (x *PropertyDefinition) GetIsRepeatable() bool
func (x *PropertyDefinition) GetIsRequired() bool
func (x *PropertyDefinition) GetIsSearchable() bool
func (x *PropertyDefinition) GetMapTypeOptions() *MapTypeOptions
func (x *PropertyDefinition) GetName() string
func (x *PropertyDefinition) GetPropertyTypeOptions() *PropertyTypeOptions
func (x *PropertyDefinition) GetTextTypeOptions() *TextTypeOptions
func (x *PropertyDefinition) GetTimestampTypeOptions() *TimestampTypeOptions
func (m *PropertyDefinition) GetValueTypeOptions() isPropertyDefinition_ValueTypeOptions
func (*PropertyDefinition) ProtoMessage()
func (x *PropertyDefinition) ProtoReflect() protoreflect.Message
func (x *PropertyDefinition) Reset()
func (x *PropertyDefinition) String() string
type PropertyDefinition_DateTimeTypeOptions struct {
// Date time property.
// It is not supported by CMEK compliant deployment.
DateTimeTypeOptions *DateTimeTypeOptions `protobuf:"bytes,13,opt,name=date_time_type_options,json=dateTimeTypeOptions,proto3,oneof"`
}
type PropertyDefinition_EnumTypeOptions struct {
// Enum/categorical property.
EnumTypeOptions *EnumTypeOptions `protobuf:"bytes,11,opt,name=enum_type_options,json=enumTypeOptions,proto3,oneof"`
}
type PropertyDefinition_FloatTypeOptions struct {
// Float property.
FloatTypeOptions *FloatTypeOptions `protobuf:"bytes,8,opt,name=float_type_options,json=floatTypeOptions,proto3,oneof"`
}
type PropertyDefinition_IntegerTypeOptions struct {
// Integer property.
IntegerTypeOptions *IntegerTypeOptions `protobuf:"bytes,7,opt,name=integer_type_options,json=integerTypeOptions,proto3,oneof"`
}
type PropertyDefinition_MapTypeOptions struct {
// Map property.
MapTypeOptions *MapTypeOptions `protobuf:"bytes,15,opt,name=map_type_options,json=mapTypeOptions,proto3,oneof"`
}
type PropertyDefinition_PropertyTypeOptions struct {
// Nested structured data property.
PropertyTypeOptions *PropertyTypeOptions `protobuf:"bytes,10,opt,name=property_type_options,json=propertyTypeOptions,proto3,oneof"`
}
type PropertyDefinition_TextTypeOptions struct {
// Text/string property.
TextTypeOptions *TextTypeOptions `protobuf:"bytes,9,opt,name=text_type_options,json=textTypeOptions,proto3,oneof"`
}
type PropertyDefinition_TimestampTypeOptions struct {
// Timestamp property.
// It is not supported by CMEK compliant deployment.
TimestampTypeOptions *TimestampTypeOptions `protobuf:"bytes,16,opt,name=timestamp_type_options,json=timestampTypeOptions,proto3,oneof"`
}
type PropertyFilter struct {
// The Document schema name [Document.document_schema_name][google.cloud.contentwarehouse.v1.Document.document_schema_name].
// Format:
// projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
DocumentSchemaName string `protobuf:"bytes,1,opt,name=document_schema_name,json=documentSchemaName,proto3" json:"document_schema_name,omitempty"`
// The filter condition.
// The syntax for this expression is a subset of SQL syntax.
//
// Supported operators are: `=`, `!=`, `<`, `<=`, `>`, `>=`, and `~~` where
// the left of the operator is a property name and the right of the operator
// is a number or a quoted string. You must escape backslash (\\) and quote
// (\") characters.
//
// `~~` is the LIKE operator. The right of the operator must be a string. The
// only supported property data type for LIKE is text_values. It provides
// semantic search functionality by parsing, stemming and doing synonyms
// expansion against the input query. It matches if the property contains
// semantic similar content to the query. It is not regex matching or wildcard
// matching. For example, "property.company ~~ \"google\"" will match records
// whose property `property.compnay` have values like "Google Inc.", "Google
// LLC" or "Google Company".
//
// Supported functions are `LOWER([property_name])` to perform a
// case insensitive match and `EMPTY([property_name])` to filter on the
// existence of a key.
//
// Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting
// (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100
// comparisons or functions are allowed in the expression. The expression must
// be < 6000 bytes in length.
//
// Only properties that are marked filterable are allowed
// ([PropertyDefinition.is_filterable][google.cloud.contentwarehouse.v1.PropertyDefinition.is_filterable]). Property names do not need to be
// prefixed by the document schema id (as is the case with histograms),
// however property names will need to be prefixed by its parent hierarchy, if
// any. For example: top_property_name.sub_property_name.
//
// Sample Query:
// `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND
// driving_years > 10`
//
// CMEK compliant deployment only supports:
//
// * Operators: `=`, `<`, `<=`, `>`, and `>=`.
// * Boolean expressions: AND and OR.
Condition string `protobuf:"bytes,2,opt,name=condition,proto3" json:"condition,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyFilter) Descriptor() ([]byte, []int)
Deprecated: Use PropertyFilter.ProtoReflect.Descriptor instead.
func (x *PropertyFilter) GetCondition() string
func (x *PropertyFilter) GetDocumentSchemaName() string
func (*PropertyFilter) ProtoMessage()
func (x *PropertyFilter) ProtoReflect() protoreflect.Message
func (x *PropertyFilter) Reset()
func (x *PropertyFilter) String() string
Configurations for a nested structured data property.
type PropertyTypeOptions struct {
// Required. List of property definitions.
PropertyDefinitions []*PropertyDefinition `protobuf:"bytes,1,rep,name=property_definitions,json=propertyDefinitions,proto3" json:"property_definitions,omitempty"`
// contains filtered or unexported fields
}
func (*PropertyTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use PropertyTypeOptions.ProtoReflect.Descriptor instead.
func (x *PropertyTypeOptions) GetPropertyDefinitions() []*PropertyDefinition
func (*PropertyTypeOptions) ProtoMessage()
func (x *PropertyTypeOptions) ProtoReflect() protoreflect.Message
func (x *PropertyTypeOptions) Reset()
func (x *PropertyTypeOptions) String() string
type Property_DateTimeValues struct {
// Date time property values.
// It is not supported by CMEK compliant deployment.
DateTimeValues *DateTimeArray `protobuf:"bytes,7,opt,name=date_time_values,json=dateTimeValues,proto3,oneof"`
}
type Property_EnumValues struct {
// Enum property values.
EnumValues *EnumArray `protobuf:"bytes,5,opt,name=enum_values,json=enumValues,proto3,oneof"`
}
type Property_FloatValues struct {
// Float property values.
FloatValues *FloatArray `protobuf:"bytes,3,opt,name=float_values,json=floatValues,proto3,oneof"`
}
type Property_IntegerValues struct {
// Integer property values.
IntegerValues *IntegerArray `protobuf:"bytes,2,opt,name=integer_values,json=integerValues,proto3,oneof"`
}
type Property_MapProperty struct {
// Map property values.
MapProperty *MapProperty `protobuf:"bytes,8,opt,name=map_property,json=mapProperty,proto3,oneof"`
}
type Property_PropertyValues struct {
// Nested structured data property values.
PropertyValues *PropertyArray `protobuf:"bytes,6,opt,name=property_values,json=propertyValues,proto3,oneof"`
}
type Property_TextValues struct {
// String/text property values.
TextValues *TextArray `protobuf:"bytes,4,opt,name=text_values,json=textValues,proto3,oneof"`
}
type Property_TimestampValues struct {
// Timestamp property values.
// It is not supported by CMEK compliant deployment.
TimestampValues *TimestampArray `protobuf:"bytes,9,opt,name=timestamp_values,json=timestampValues,proto3,oneof"`
}
Represents the action responsible for publishing messages to a Pub/Sub topic.
type PublishAction struct {
// The topic id in the Pub/Sub service for which messages will be published
// to.
TopicId string `protobuf:"bytes,1,opt,name=topic_id,json=topicId,proto3" json:"topic_id,omitempty"`
// Messages to be published.
Messages []string `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
// contains filtered or unexported fields
}
func (*PublishAction) Descriptor() ([]byte, []int)
Deprecated: Use PublishAction.ProtoReflect.Descriptor instead.
func (x *PublishAction) GetMessages() []string
func (x *PublishAction) GetTopicId() string
func (*PublishAction) ProtoMessage()
func (x *PublishAction) ProtoReflect() protoreflect.Message
func (x *PublishAction) Reset()
func (x *PublishAction) String() string
Additional result info for the question-answering feature.
type QAResult struct {
// Highlighted sections in the snippet.
Highlights []*QAResult_Highlight `protobuf:"bytes,1,rep,name=highlights,proto3" json:"highlights,omitempty"`
// The calibrated confidence score for this document, in the range
// [0., 1.]. This represents the confidence level for whether the returned
// document and snippet answers the user's query.
ConfidenceScore float32 `protobuf:"fixed32,2,opt,name=confidence_score,json=confidenceScore,proto3" json:"confidence_score,omitempty"`
// contains filtered or unexported fields
}
func (*QAResult) Descriptor() ([]byte, []int)
Deprecated: Use QAResult.ProtoReflect.Descriptor instead.
func (x *QAResult) GetConfidenceScore() float32
func (x *QAResult) GetHighlights() []*QAResult_Highlight
func (*QAResult) ProtoMessage()
func (x *QAResult) ProtoReflect() protoreflect.Message
func (x *QAResult) Reset()
func (x *QAResult) String() string
A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).
type QAResult_Highlight struct {
// Start index of the highlight.
StartIndex int32 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3" json:"start_index,omitempty"`
// End index of the highlight, exclusive.
EndIndex int32 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3" json:"end_index,omitempty"`
// contains filtered or unexported fields
}
func (*QAResult_Highlight) Descriptor() ([]byte, []int)
Deprecated: Use QAResult_Highlight.ProtoReflect.Descriptor instead.
func (x *QAResult_Highlight) GetEndIndex() int32
func (x *QAResult_Highlight) GetStartIndex() int32
func (*QAResult_Highlight) ProtoMessage()
func (x *QAResult_Highlight) ProtoReflect() protoreflect.Message
func (x *QAResult_Highlight) Reset()
func (x *QAResult_Highlight) String() string
When a raw document is supplied, this indicates the file format
type RawDocumentFileType int32
const (
// No raw document specified or it is non-parsable
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED RawDocumentFileType = 0
// Adobe PDF format
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_PDF RawDocumentFileType = 1
// Microsoft Word format
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_DOCX RawDocumentFileType = 2
// Microsoft Excel format
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_XLSX RawDocumentFileType = 3
// Microsoft Powerpoint format
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_PPTX RawDocumentFileType = 4
// UTF-8 encoded text format
RawDocumentFileType_RAW_DOCUMENT_FILE_TYPE_TEXT RawDocumentFileType = 5
)
func (RawDocumentFileType) Descriptor() protoreflect.EnumDescriptor
func (x RawDocumentFileType) Enum() *RawDocumentFileType
func (RawDocumentFileType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RawDocumentFileType.Descriptor instead.
func (x RawDocumentFileType) Number() protoreflect.EnumNumber
func (x RawDocumentFileType) String() string
func (RawDocumentFileType) Type() protoreflect.EnumType
Represents the action responsible for remove a document from a specific folder.
type RemoveFromFolderAction struct {
// Condition of the action to be executed.
Condition string `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"`
// Name of the folder under which new document is to be added.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}.
Folder string `protobuf:"bytes,2,opt,name=folder,proto3" json:"folder,omitempty"`
// contains filtered or unexported fields
}
func (*RemoveFromFolderAction) Descriptor() ([]byte, []int)
Deprecated: Use RemoveFromFolderAction.ProtoReflect.Descriptor instead.
func (x *RemoveFromFolderAction) GetCondition() string
func (x *RemoveFromFolderAction) GetFolder() string
func (*RemoveFromFolderAction) ProtoMessage()
func (x *RemoveFromFolderAction) ProtoReflect() protoreflect.Message
func (x *RemoveFromFolderAction) Reset()
func (x *RemoveFromFolderAction) String() string
Meta information is used to improve the performance of the service.
type RequestMetadata struct {
// Provides user unique identification and groups information.
UserInfo *UserInfo `protobuf:"bytes,1,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
// contains filtered or unexported fields
}
func (*RequestMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RequestMetadata.ProtoReflect.Descriptor instead.
func (x *RequestMetadata) GetUserInfo() *UserInfo
func (*RequestMetadata) ProtoMessage()
func (x *RequestMetadata) ProtoReflect() protoreflect.Message
func (x *RequestMetadata) Reset()
func (x *RequestMetadata) String() string
Additional information returned to client, such as debugging information.
type ResponseMetadata struct {
// A unique id associated with this call. This id is logged for tracking
// purpose.
RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}
func (*ResponseMetadata) Descriptor() ([]byte, []int)
Deprecated: Use ResponseMetadata.ProtoReflect.Descriptor instead.
func (x *ResponseMetadata) GetRequestId() string
func (*ResponseMetadata) ProtoMessage()
func (x *ResponseMetadata) ProtoReflect() protoreflect.Message
func (x *ResponseMetadata) Reset()
func (x *ResponseMetadata) String() string
Represents the rule for a content warehouse trigger.
type Rule struct {
// Short description of the rule and its context.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// ID of the rule. It has to be unique across all the examples.
// This is managed internally.
RuleId string `protobuf:"bytes,2,opt,name=rule_id,json=ruleId,proto3" json:"rule_id,omitempty"`
// Identifies the trigger type for running the policy.
TriggerType Rule_TriggerType `protobuf:"varint,3,opt,name=trigger_type,json=triggerType,proto3,enum=google.cloud.contentwarehouse.v1.Rule_TriggerType" json:"trigger_type,omitempty"`
// Represents the conditional expression to be evaluated.
// Expression should evaluate to a boolean result.
// When the condition is true actions are executed.
// Example: user_role = "hsbc_role_1" AND doc.salary > 20000
Condition string `protobuf:"bytes,4,opt,name=condition,proto3" json:"condition,omitempty"`
// List of actions that are executed when the rule is satisfied.
Actions []*Action `protobuf:"bytes,5,rep,name=actions,proto3" json:"actions,omitempty"`
// contains filtered or unexported fields
}
func (*Rule) Descriptor() ([]byte, []int)
Deprecated: Use Rule.ProtoReflect.Descriptor instead.
func (x *Rule) GetActions() []*Action
func (x *Rule) GetCondition() string
func (x *Rule) GetDescription() string
func (x *Rule) GetRuleId() string
func (x *Rule) GetTriggerType() Rule_TriggerType
func (*Rule) ProtoMessage()
func (x *Rule) ProtoReflect() protoreflect.Message
func (x *Rule) Reset()
func (x *Rule) String() string
Represents a rule and outputs of associated actions.
type RuleActionsPair struct {
// Represents the rule.
Rule *Rule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"`
// Outputs of executing the actions associated with the above rule.
ActionOutputs []*ActionOutput `protobuf:"bytes,2,rep,name=action_outputs,json=actionOutputs,proto3" json:"action_outputs,omitempty"`
// contains filtered or unexported fields
}
func (*RuleActionsPair) Descriptor() ([]byte, []int)
Deprecated: Use RuleActionsPair.ProtoReflect.Descriptor instead.
func (x *RuleActionsPair) GetActionOutputs() []*ActionOutput
func (x *RuleActionsPair) GetRule() *Rule
func (*RuleActionsPair) ProtoMessage()
func (x *RuleActionsPair) ProtoReflect() protoreflect.Message
func (x *RuleActionsPair) Reset()
func (x *RuleActionsPair) String() string
Records the output of Rule Engine including rule evaluation and actions result.
type RuleEngineOutput struct {
// Name of the document against which the rules and actions were evaluated.
DocumentName string `protobuf:"bytes,3,opt,name=document_name,json=documentName,proto3" json:"document_name,omitempty"`
// Output from Rule Evaluator containing matched, unmatched and invalid rules.
RuleEvaluatorOutput *RuleEvaluatorOutput `protobuf:"bytes,1,opt,name=rule_evaluator_output,json=ruleEvaluatorOutput,proto3" json:"rule_evaluator_output,omitempty"`
// Output from Action Executor containing rule and corresponding actions
// execution result.
ActionExecutorOutput *ActionExecutorOutput `protobuf:"bytes,2,opt,name=action_executor_output,json=actionExecutorOutput,proto3" json:"action_executor_output,omitempty"`
// contains filtered or unexported fields
}
func (*RuleEngineOutput) Descriptor() ([]byte, []int)
Deprecated: Use RuleEngineOutput.ProtoReflect.Descriptor instead.
func (x *RuleEngineOutput) GetActionExecutorOutput() *ActionExecutorOutput
func (x *RuleEngineOutput) GetDocumentName() string
func (x *RuleEngineOutput) GetRuleEvaluatorOutput() *RuleEvaluatorOutput
func (*RuleEngineOutput) ProtoMessage()
func (x *RuleEngineOutput) ProtoReflect() protoreflect.Message
func (x *RuleEngineOutput) Reset()
func (x *RuleEngineOutput) String() string
Represents the output of the Rule Evaluator.
type RuleEvaluatorOutput struct {
// List of rules fetched from database for the given request trigger type.
TriggeredRules []*Rule `protobuf:"bytes,1,rep,name=triggered_rules,json=triggeredRules,proto3" json:"triggered_rules,omitempty"`
// A subset of triggered rules that are evaluated true for a given request.
MatchedRules []*Rule `protobuf:"bytes,2,rep,name=matched_rules,json=matchedRules,proto3" json:"matched_rules,omitempty"`
// A subset of triggered rules that failed the validation check(s) after
// parsing.
InvalidRules []*InvalidRule `protobuf:"bytes,3,rep,name=invalid_rules,json=invalidRules,proto3" json:"invalid_rules,omitempty"`
// contains filtered or unexported fields
}
func (*RuleEvaluatorOutput) Descriptor() ([]byte, []int)
Deprecated: Use RuleEvaluatorOutput.ProtoReflect.Descriptor instead.
func (x *RuleEvaluatorOutput) GetInvalidRules() []*InvalidRule
func (x *RuleEvaluatorOutput) GetMatchedRules() []*Rule
func (x *RuleEvaluatorOutput) GetTriggeredRules() []*Rule
func (*RuleEvaluatorOutput) ProtoMessage()
func (x *RuleEvaluatorOutput) ProtoReflect() protoreflect.Message
func (x *RuleEvaluatorOutput) Reset()
func (x *RuleEvaluatorOutput) String() string
Represents a set of rules from a single customer.
type RuleSet struct {
// The resource name of the rule set. Managed internally.
// Format:
// projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}.
//
// The name is ignored when creating a rule set.
Name string `protobuf:"bytes,6,opt,name=name,proto3" json:"name,omitempty"`
// Short description of the rule-set.
Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
// Source of the rules i.e., customer name.
Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
// List of rules given by the customer.
Rules []*Rule `protobuf:"bytes,3,rep,name=rules,proto3" json:"rules,omitempty"`
// contains filtered or unexported fields
}
func (*RuleSet) Descriptor() ([]byte, []int)
Deprecated: Use RuleSet.ProtoReflect.Descriptor instead.
func (x *RuleSet) GetDescription() string
func (x *RuleSet) GetName() string
func (x *RuleSet) GetRules() []*Rule
func (x *RuleSet) GetSource() string
func (*RuleSet) ProtoMessage()
func (x *RuleSet) ProtoReflect() protoreflect.Message
func (x *RuleSet) Reset()
func (x *RuleSet) String() string
RuleSetServiceClient is the client API for RuleSetService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type RuleSetServiceClient interface {
// Creates a ruleset.
CreateRuleSet(ctx context.Context, in *CreateRuleSetRequest, opts ...grpc.CallOption) (*RuleSet, error)
// Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.
GetRuleSet(ctx context.Context, in *GetRuleSetRequest, opts ...grpc.CallOption) (*RuleSet, error)
// Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset
// is non-empty and does not equal the existing name.
UpdateRuleSet(ctx context.Context, in *UpdateRuleSetRequest, opts ...grpc.CallOption) (*RuleSet, error)
// Deletes a ruleset. Returns NOT_FOUND if the document does not exist.
DeleteRuleSet(ctx context.Context, in *DeleteRuleSetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists rulesets.
ListRuleSets(ctx context.Context, in *ListRuleSetsRequest, opts ...grpc.CallOption) (*ListRuleSetsResponse, error)
}
func NewRuleSetServiceClient(cc grpc.ClientConnInterface) RuleSetServiceClient
RuleSetServiceServer is the server API for RuleSetService service.
type RuleSetServiceServer interface {
// Creates a ruleset.
CreateRuleSet(context.Context, *CreateRuleSetRequest) (*RuleSet, error)
// Gets a ruleset. Returns NOT_FOUND if the ruleset does not exist.
GetRuleSet(context.Context, *GetRuleSetRequest) (*RuleSet, error)
// Updates a ruleset. Returns INVALID_ARGUMENT if the name of the ruleset
// is non-empty and does not equal the existing name.
UpdateRuleSet(context.Context, *UpdateRuleSetRequest) (*RuleSet, error)
// Deletes a ruleset. Returns NOT_FOUND if the document does not exist.
DeleteRuleSet(context.Context, *DeleteRuleSetRequest) (*emptypb.Empty, error)
// Lists rulesets.
ListRuleSets(context.Context, *ListRuleSetsRequest) (*ListRuleSetsResponse, error)
}
type Rule_TriggerType int32
const (
Rule_UNKNOWN Rule_TriggerType = 0
// Trigger for create document action.
Rule_ON_CREATE Rule_TriggerType = 1
// Trigger for update document action.
Rule_ON_UPDATE Rule_TriggerType = 4
)
func (Rule_TriggerType) Descriptor() protoreflect.EnumDescriptor
func (x Rule_TriggerType) Enum() *Rule_TriggerType
func (Rule_TriggerType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Rule_TriggerType.Descriptor instead.
func (x Rule_TriggerType) Number() protoreflect.EnumNumber
func (x Rule_TriggerType) String() string
func (Rule_TriggerType) Type() protoreflect.EnumType
Request message for DocumentService.SearchDocuments.
type SearchDocumentsRequest struct {
// Required. The parent, which owns this collection of documents.
// Format: projects/{project_number}/locations/{location}.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The meta information collected about the end user, used to enforce access
// control and improve the search quality of the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,3,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// Query used to search against documents (keyword, filters, etc.).
DocumentQuery *DocumentQuery `protobuf:"bytes,4,opt,name=document_query,json=documentQuery,proto3" json:"document_query,omitempty"`
// An integer that specifies the current offset (that is, starting result
// location, amongst the documents deemed by the API as relevant) in search
// results. This field is only considered if [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token] is unset.
//
// The maximum allowed value is 5000. Otherwise an error is thrown.
//
// For example, 0 means to return results starting from the first matching
// document, and 10 means to return from the 11th document. This can be used
// for pagination, (for example, pageSize = 10 and offset = 10 means to return
// from the second page).
Offset int32 `protobuf:"varint,5,opt,name=offset,proto3" json:"offset,omitempty"`
// A limit on the number of documents returned in the search results.
// Increasing this value above the default value of 10 can increase search
// response time. The value can be between 1 and 100.
PageSize int32 `protobuf:"varint,6,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The token specifying the current offset within search results.
// See [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] for an explanation of how
// to obtain the next set of query results.
PageToken string `protobuf:"bytes,7,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// The criteria determining how search results are sorted. For non-empty
// query, default is `"relevance desc"`. For empty query, default is
// `"upload_date desc"`.
//
// Supported options are:
//
// - `"relevance desc"`: By relevance descending, as determined by the API
// algorithms.
// - `"upload_date desc"`: By upload date descending.
// - `"upload_date"`: By upload date ascending.
// - `"update_date desc"`: By last updated date descending.
// - `"update_date"`: By last updated date ascending.
OrderBy string `protobuf:"bytes,8,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// An expression specifying a histogram request against matching
// documents. Expression syntax is an aggregation function call with
// histogram facets and other options.
//
// The following aggregation functions are supported:
//
// * `count(string_histogram_facet)`: Count the number of matching entities
// for each distinct attribute value.
//
// Data types:
//
// * Histogram facet (aka filterable properties): Facet names with format
// <schema id>.<facet>. Facets will have the
// format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child
// facet, then the parent hierarchy needs to be specified separated by
// dots in the prefix after the schema id. Thus, the format for a multi-
// level facet is: <schema id>.<parent facet name>.
// <child facet name>. Example:
// schema123.root_parent_facet.middle_facet.child_facet
// * DocumentSchemaId: (with no schema id prefix) to get
// histograms for each document type (returns the schema id path, e.g.
// projects/12345/locations/us-west/documentSchemas/abc123).
//
// Example expression:
//
// - Document type counts:
// count('DocumentSchemaId')
//
// - For schema id, abc123, get the counts for MORTGAGE_TYPE:
// count('abc123.MORTGAGE_TYPE')
HistogramQueries []*HistogramQuery `protobuf:"bytes,9,rep,name=histogram_queries,json=histogramQueries,proto3" json:"histogram_queries,omitempty"`
// Optional. Controls if the search document request requires the return of a total size
// of matched documents. See [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size].
//
// Enabling this flag may adversely impact performance. Hint: If this is
// used with pagination, set this flag on the initial query but set this
// to false on subsequent page calls (keep the total count locally).
//
// Defaults to false.
RequireTotalSize bool `protobuf:"varint,10,opt,name=require_total_size,json=requireTotalSize,proto3" json:"require_total_size,omitempty"`
// Experimental, do not use.
// The limit on the number of documents returned for the question-answering
// feature. To enable the question-answering feature, set
// [DocumentQuery].[is_nl_query][] to true.
QaSizeLimit int32 `protobuf:"varint,11,opt,name=qa_size_limit,json=qaSizeLimit,proto3" json:"qa_size_limit,omitempty"`
// contains filtered or unexported fields
}
func (*SearchDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchDocumentsRequest.ProtoReflect.Descriptor instead.
func (x *SearchDocumentsRequest) GetDocumentQuery() *DocumentQuery
func (x *SearchDocumentsRequest) GetHistogramQueries() []*HistogramQuery
func (x *SearchDocumentsRequest) GetOffset() int32
func (x *SearchDocumentsRequest) GetOrderBy() string
func (x *SearchDocumentsRequest) GetPageSize() int32
func (x *SearchDocumentsRequest) GetPageToken() string
func (x *SearchDocumentsRequest) GetParent() string
func (x *SearchDocumentsRequest) GetQaSizeLimit() int32
func (x *SearchDocumentsRequest) GetRequestMetadata() *RequestMetadata
func (x *SearchDocumentsRequest) GetRequireTotalSize() bool
func (*SearchDocumentsRequest) ProtoMessage()
func (x *SearchDocumentsRequest) ProtoReflect() protoreflect.Message
func (x *SearchDocumentsRequest) Reset()
func (x *SearchDocumentsRequest) String() string
Response message for DocumentService.SearchDocuments.
type SearchDocumentsResponse struct {
// The document entities that match the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
MatchingDocuments []*SearchDocumentsResponse_MatchingDocument `protobuf:"bytes,1,rep,name=matching_documents,json=matchingDocuments,proto3" json:"matching_documents,omitempty"`
// The token that specifies the starting position of the next page of results.
// This field is empty if there are no more results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// The total number of matched documents which is available only if the client
// set [SearchDocumentsRequest.require_total_size][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.require_total_size] to `true`. Otherwise, the
// value will be `-1`. `total_size` will max at "100,000". If this
// is returned, then it can be assumed that the count is equal to or greater
// than 100,000. Typically a UI would handle this condition by displaying
// "of many", for example: "Displaying 10 of many".
TotalSize int32 `protobuf:"varint,3,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"`
// Additional information for the API invocation, such as the request tracking
// id.
Metadata *ResponseMetadata `protobuf:"bytes,4,opt,name=metadata,proto3" json:"metadata,omitempty"`
// The histogram results that match with the specified
// [SearchDocumentsRequest.histogram_queries][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.histogram_queries].
HistogramQueryResults []*HistogramQueryResult `protobuf:"bytes,6,rep,name=histogram_query_results,json=histogramQueryResults,proto3" json:"histogram_query_results,omitempty"`
// contains filtered or unexported fields
}
func (*SearchDocumentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchDocumentsResponse.ProtoReflect.Descriptor instead.
func (x *SearchDocumentsResponse) GetHistogramQueryResults() []*HistogramQueryResult
func (x *SearchDocumentsResponse) GetMatchingDocuments() []*SearchDocumentsResponse_MatchingDocument
func (x *SearchDocumentsResponse) GetMetadata() *ResponseMetadata
func (x *SearchDocumentsResponse) GetNextPageToken() string
func (x *SearchDocumentsResponse) GetTotalSize() int32
func (*SearchDocumentsResponse) ProtoMessage()
func (x *SearchDocumentsResponse) ProtoReflect() protoreflect.Message
func (x *SearchDocumentsResponse) Reset()
func (x *SearchDocumentsResponse) String() string
Document entry with metadata inside SearchDocumentsResponse[google.cloud.contentwarehouse.v1.SearchDocumentsResponse]
type SearchDocumentsResponse_MatchingDocument struct {
// Document that matches the specified [SearchDocumentsRequest][google.cloud.contentwarehouse.v1.SearchDocumentsRequest].
// This document only contains indexed metadata information.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// Contains snippets of text from the document full raw text that most
// closely match a search query's keywords, if available. All HTML tags in
// the original fields are stripped when returned in this field, and
// matching query keywords are enclosed in HTML bold tags.
//
// If the question-answering feature is enabled, this field will instead
// contain a snippet that answers the user's natural-language query. No HTML
// bold tags will be present, and highlights in the answer snippet can be
// found in [QAResult.highlights][google.cloud.contentwarehouse.v1.QAResult.highlights].
SearchTextSnippet string `protobuf:"bytes,2,opt,name=search_text_snippet,json=searchTextSnippet,proto3" json:"search_text_snippet,omitempty"`
// Experimental.
// Additional result info if the question-answering feature is enabled.
QaResult *QAResult `protobuf:"bytes,3,opt,name=qa_result,json=qaResult,proto3" json:"qa_result,omitempty"`
// contains filtered or unexported fields
}
func (*SearchDocumentsResponse_MatchingDocument) Descriptor() ([]byte, []int)
Deprecated: Use SearchDocumentsResponse_MatchingDocument.ProtoReflect.Descriptor instead.
func (x *SearchDocumentsResponse_MatchingDocument) GetDocument() *Document
func (x *SearchDocumentsResponse_MatchingDocument) GetQaResult() *QAResult
func (x *SearchDocumentsResponse_MatchingDocument) GetSearchTextSnippet() string
func (*SearchDocumentsResponse_MatchingDocument) ProtoMessage()
func (x *SearchDocumentsResponse_MatchingDocument) ProtoReflect() protoreflect.Message
func (x *SearchDocumentsResponse_MatchingDocument) Reset()
func (x *SearchDocumentsResponse_MatchingDocument) String() string
Request message for DocumentService.SetAcl.
type SetAclRequest struct {
// Required. REQUIRED: The resource for which the policy is being requested.
// Format for document:
// projects/{project_number}/locations/{location}/documents/{document_id}.
// Format for project: projects/{project_number}.
Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// Required. REQUIRED: The complete policy to be applied to the `resource`. The size of
// the policy is limited to a few 10s of KB.
Policy *v1.Policy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,3,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// For Set Project ACL only. Authorization check for end user will be ignored
// when project_owner=true.
ProjectOwner bool `protobuf:"varint,4,opt,name=project_owner,json=projectOwner,proto3" json:"project_owner,omitempty"`
// contains filtered or unexported fields
}
func (*SetAclRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetAclRequest.ProtoReflect.Descriptor instead.
func (x *SetAclRequest) GetPolicy() *v1.Policy
func (x *SetAclRequest) GetProjectOwner() bool
func (x *SetAclRequest) GetRequestMetadata() *RequestMetadata
func (x *SetAclRequest) GetResource() string
func (*SetAclRequest) ProtoMessage()
func (x *SetAclRequest) ProtoReflect() protoreflect.Message
func (x *SetAclRequest) Reset()
func (x *SetAclRequest) String() string
Response message for DocumentService.SetAcl.
type SetAclResponse struct {
// The policy will be attached to a resource (e.g. projecct, document).
Policy *v1.Policy `protobuf:"bytes,1,opt,name=policy,proto3" json:"policy,omitempty"`
// Additional information for the API invocation, such as the request tracking
// id.
Metadata *ResponseMetadata `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
func (*SetAclResponse) Descriptor() ([]byte, []int)
Deprecated: Use SetAclResponse.ProtoReflect.Descriptor instead.
func (x *SetAclResponse) GetMetadata() *ResponseMetadata
func (x *SetAclResponse) GetPolicy() *v1.Policy
func (*SetAclResponse) ProtoMessage()
func (x *SetAclResponse) ProtoReflect() protoreflect.Message
func (x *SetAclResponse) Reset()
func (x *SetAclResponse) String() string
Represents a list of synonyms for a given context. For example a context "sales" could contain: Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint
type SynonymSet struct {
// The resource name of the SynonymSet
// This is mandatory for google.api.resource.
// Format:
// projects/{project_number}/locations/{location}/synonymSets/{context}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// This is a freeform field. Example contexts can be "sales," "engineering,"
// "real estate," "accounting," etc.
// The context can be supplied during search requests.
Context string `protobuf:"bytes,2,opt,name=context,proto3" json:"context,omitempty"`
// List of Synonyms for the context.
Synonyms []*SynonymSet_Synonym `protobuf:"bytes,3,rep,name=synonyms,proto3" json:"synonyms,omitempty"`
// contains filtered or unexported fields
}
func (*SynonymSet) Descriptor() ([]byte, []int)
Deprecated: Use SynonymSet.ProtoReflect.Descriptor instead.
func (x *SynonymSet) GetContext() string
func (x *SynonymSet) GetName() string
func (x *SynonymSet) GetSynonyms() []*SynonymSet_Synonym
func (*SynonymSet) ProtoMessage()
func (x *SynonymSet) ProtoReflect() protoreflect.Message
func (x *SynonymSet) Reset()
func (x *SynonymSet) String() string
SynonymSetServiceClient is the client API for SynonymSetService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type SynonymSetServiceClient interface {
// Creates a SynonymSet for a single context.
// Throws an ALREADY_EXISTS exception if a synonymset already exists
// for the context.
CreateSynonymSet(ctx context.Context, in *CreateSynonymSetRequest, opts ...grpc.CallOption) (*SynonymSet, error)
// Gets a SynonymSet for a particular context.
// Throws a NOT_FOUND exception if the Synonymset
// does not exist
GetSynonymSet(ctx context.Context, in *GetSynonymSetRequest, opts ...grpc.CallOption) (*SynonymSet, error)
// Remove the existing SynonymSet for the context and replaces it
// with a new one.
// Throws a NOT_FOUND exception if the SynonymSet is not found.
UpdateSynonymSet(ctx context.Context, in *UpdateSynonymSetRequest, opts ...grpc.CallOption) (*SynonymSet, error)
// Deletes a SynonymSet for a given context.
// Throws a NOT_FOUND exception if the SynonymSet is not found.
DeleteSynonymSet(ctx context.Context, in *DeleteSynonymSetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns all SynonymSets (for all contexts) for the specified location.
ListSynonymSets(ctx context.Context, in *ListSynonymSetsRequest, opts ...grpc.CallOption) (*ListSynonymSetsResponse, error)
}
func NewSynonymSetServiceClient(cc grpc.ClientConnInterface) SynonymSetServiceClient
SynonymSetServiceServer is the server API for SynonymSetService service.
type SynonymSetServiceServer interface {
// Creates a SynonymSet for a single context.
// Throws an ALREADY_EXISTS exception if a synonymset already exists
// for the context.
CreateSynonymSet(context.Context, *CreateSynonymSetRequest) (*SynonymSet, error)
// Gets a SynonymSet for a particular context.
// Throws a NOT_FOUND exception if the Synonymset
// does not exist
GetSynonymSet(context.Context, *GetSynonymSetRequest) (*SynonymSet, error)
// Remove the existing SynonymSet for the context and replaces it
// with a new one.
// Throws a NOT_FOUND exception if the SynonymSet is not found.
UpdateSynonymSet(context.Context, *UpdateSynonymSetRequest) (*SynonymSet, error)
// Deletes a SynonymSet for a given context.
// Throws a NOT_FOUND exception if the SynonymSet is not found.
DeleteSynonymSet(context.Context, *DeleteSynonymSetRequest) (*emptypb.Empty, error)
// Returns all SynonymSets (for all contexts) for the specified location.
ListSynonymSets(context.Context, *ListSynonymSetsRequest) (*ListSynonymSetsResponse, error)
}
Represents a list of words given by the customer All these words are synonyms of each other.
type SynonymSet_Synonym struct {
// For example: sale, invoice, bill, order
Words []string `protobuf:"bytes,1,rep,name=words,proto3" json:"words,omitempty"`
// contains filtered or unexported fields
}
func (*SynonymSet_Synonym) Descriptor() ([]byte, []int)
Deprecated: Use SynonymSet_Synonym.ProtoReflect.Descriptor instead.
func (x *SynonymSet_Synonym) GetWords() []string
func (*SynonymSet_Synonym) ProtoMessage()
func (x *SynonymSet_Synonym) ProtoReflect() protoreflect.Message
func (x *SynonymSet_Synonym) Reset()
func (x *SynonymSet_Synonym) String() string
String/text values.
type TextArray struct {
// List of text values.
Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*TextArray) Descriptor() ([]byte, []int)
Deprecated: Use TextArray.ProtoReflect.Descriptor instead.
func (x *TextArray) GetValues() []string
func (*TextArray) ProtoMessage()
func (x *TextArray) ProtoReflect() protoreflect.Message
func (x *TextArray) Reset()
func (x *TextArray) String() string
Configurations for a text property.
type TextTypeOptions struct {
// contains filtered or unexported fields
}
func (*TextTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use TextTypeOptions.ProtoReflect.Descriptor instead.
func (*TextTypeOptions) ProtoMessage()
func (x *TextTypeOptions) ProtoReflect() protoreflect.Message
func (x *TextTypeOptions) Reset()
func (x *TextTypeOptions) String() string
Filter on create timestamp or update timestamp of documents.
type TimeFilter struct {
TimeRange *interval.Interval `protobuf:"bytes,1,opt,name=time_range,json=timeRange,proto3" json:"time_range,omitempty"`
// Specifies which time field to filter documents on.
//
// Defaults to [TimeField.UPLOAD_TIME][].
TimeField TimeFilter_TimeField `protobuf:"varint,2,opt,name=time_field,json=timeField,proto3,enum=google.cloud.contentwarehouse.v1.TimeFilter_TimeField" json:"time_field,omitempty"`
// contains filtered or unexported fields
}
func (*TimeFilter) Descriptor() ([]byte, []int)
Deprecated: Use TimeFilter.ProtoReflect.Descriptor instead.
func (x *TimeFilter) GetTimeField() TimeFilter_TimeField
func (x *TimeFilter) GetTimeRange() *interval.Interval
func (*TimeFilter) ProtoMessage()
func (x *TimeFilter) ProtoReflect() protoreflect.Message
func (x *TimeFilter) Reset()
func (x *TimeFilter) String() string
Time field used in TimeFilter.
type TimeFilter_TimeField int32
const (
// Default value.
TimeFilter_TIME_FIELD_UNSPECIFIED TimeFilter_TimeField = 0
// Earliest document create time.
TimeFilter_CREATE_TIME TimeFilter_TimeField = 1
// Latest document update time.
TimeFilter_UPDATE_TIME TimeFilter_TimeField = 2
)
func (TimeFilter_TimeField) Descriptor() protoreflect.EnumDescriptor
func (x TimeFilter_TimeField) Enum() *TimeFilter_TimeField
func (TimeFilter_TimeField) EnumDescriptor() ([]byte, []int)
Deprecated: Use TimeFilter_TimeField.Descriptor instead.
func (x TimeFilter_TimeField) Number() protoreflect.EnumNumber
func (x TimeFilter_TimeField) String() string
func (TimeFilter_TimeField) Type() protoreflect.EnumType
Timestamp values.
type TimestampArray struct {
// List of timestamp values.
Values []*TimestampValue `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*TimestampArray) Descriptor() ([]byte, []int)
Deprecated: Use TimestampArray.ProtoReflect.Descriptor instead.
func (x *TimestampArray) GetValues() []*TimestampValue
func (*TimestampArray) ProtoMessage()
func (x *TimestampArray) ProtoReflect() protoreflect.Message
func (x *TimestampArray) Reset()
func (x *TimestampArray) String() string
Configurations for a timestamp property.
type TimestampTypeOptions struct {
// contains filtered or unexported fields
}
func (*TimestampTypeOptions) Descriptor() ([]byte, []int)
Deprecated: Use TimestampTypeOptions.ProtoReflect.Descriptor instead.
func (*TimestampTypeOptions) ProtoMessage()
func (x *TimestampTypeOptions) ProtoReflect() protoreflect.Message
func (x *TimestampTypeOptions) Reset()
func (x *TimestampTypeOptions) String() string
Timestamp value type.
type TimestampValue struct {
// Types that are assignable to Value:
//
// *TimestampValue_TimestampValue
// *TimestampValue_TextValue
Value isTimestampValue_Value `protobuf_oneof:"value"`
// contains filtered or unexported fields
}
func (*TimestampValue) Descriptor() ([]byte, []int)
Deprecated: Use TimestampValue.ProtoReflect.Descriptor instead.
func (x *TimestampValue) GetTextValue() string
func (x *TimestampValue) GetTimestampValue() *timestamppb.Timestamp
func (m *TimestampValue) GetValue() isTimestampValue_Value
func (*TimestampValue) ProtoMessage()
func (x *TimestampValue) ProtoReflect() protoreflect.Message
func (x *TimestampValue) Reset()
func (x *TimestampValue) String() string
type TimestampValue_TextValue struct {
// The string must represent a valid instant in UTC and is parsed using
// java.time.format.DateTimeFormatter.ISO_INSTANT.
// e.g. "2013-09-29T18:46:19Z"
TextValue string `protobuf:"bytes,2,opt,name=text_value,json=textValue,proto3,oneof"`
}
type TimestampValue_TimestampValue struct {
// Timestamp value
TimestampValue *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}
UnimplementedDocumentLinkServiceServer can be embedded to have forward compatible implementations.
type UnimplementedDocumentLinkServiceServer struct {
}
func (*UnimplementedDocumentLinkServiceServer) CreateDocumentLink(context.Context, *CreateDocumentLinkRequest) (*DocumentLink, error)
func (*UnimplementedDocumentLinkServiceServer) DeleteDocumentLink(context.Context, *DeleteDocumentLinkRequest) (*emptypb.Empty, error)
func (*UnimplementedDocumentLinkServiceServer) ListLinkedSources(context.Context, *ListLinkedSourcesRequest) (*ListLinkedSourcesResponse, error)
func (*UnimplementedDocumentLinkServiceServer) ListLinkedTargets(context.Context, *ListLinkedTargetsRequest) (*ListLinkedTargetsResponse, error)
UnimplementedDocumentSchemaServiceServer can be embedded to have forward compatible implementations.
type UnimplementedDocumentSchemaServiceServer struct {
}
func (*UnimplementedDocumentSchemaServiceServer) CreateDocumentSchema(context.Context, *CreateDocumentSchemaRequest) (*DocumentSchema, error)
func (*UnimplementedDocumentSchemaServiceServer) DeleteDocumentSchema(context.Context, *DeleteDocumentSchemaRequest) (*emptypb.Empty, error)
func (*UnimplementedDocumentSchemaServiceServer) GetDocumentSchema(context.Context, *GetDocumentSchemaRequest) (*DocumentSchema, error)
func (*UnimplementedDocumentSchemaServiceServer) ListDocumentSchemas(context.Context, *ListDocumentSchemasRequest) (*ListDocumentSchemasResponse, error)
func (*UnimplementedDocumentSchemaServiceServer) UpdateDocumentSchema(context.Context, *UpdateDocumentSchemaRequest) (*DocumentSchema, error)
UnimplementedDocumentServiceServer can be embedded to have forward compatible implementations.
type UnimplementedDocumentServiceServer struct {
}
func (*UnimplementedDocumentServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*CreateDocumentResponse, error)
func (*UnimplementedDocumentServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
func (*UnimplementedDocumentServiceServer) FetchAcl(context.Context, *FetchAclRequest) (*FetchAclResponse, error)
func (*UnimplementedDocumentServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
func (*UnimplementedDocumentServiceServer) SearchDocuments(context.Context, *SearchDocumentsRequest) (*SearchDocumentsResponse, error)
func (*UnimplementedDocumentServiceServer) SetAcl(context.Context, *SetAclRequest) (*SetAclResponse, error)
func (*UnimplementedDocumentServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*UpdateDocumentResponse, error)
UnimplementedRuleSetServiceServer can be embedded to have forward compatible implementations.
type UnimplementedRuleSetServiceServer struct {
}
func (*UnimplementedRuleSetServiceServer) CreateRuleSet(context.Context, *CreateRuleSetRequest) (*RuleSet, error)
func (*UnimplementedRuleSetServiceServer) DeleteRuleSet(context.Context, *DeleteRuleSetRequest) (*emptypb.Empty, error)
func (*UnimplementedRuleSetServiceServer) GetRuleSet(context.Context, *GetRuleSetRequest) (*RuleSet, error)
func (*UnimplementedRuleSetServiceServer) ListRuleSets(context.Context, *ListRuleSetsRequest) (*ListRuleSetsResponse, error)
func (*UnimplementedRuleSetServiceServer) UpdateRuleSet(context.Context, *UpdateRuleSetRequest) (*RuleSet, error)
UnimplementedSynonymSetServiceServer can be embedded to have forward compatible implementations.
type UnimplementedSynonymSetServiceServer struct {
}
func (*UnimplementedSynonymSetServiceServer) CreateSynonymSet(context.Context, *CreateSynonymSetRequest) (*SynonymSet, error)
func (*UnimplementedSynonymSetServiceServer) DeleteSynonymSet(context.Context, *DeleteSynonymSetRequest) (*emptypb.Empty, error)
func (*UnimplementedSynonymSetServiceServer) GetSynonymSet(context.Context, *GetSynonymSetRequest) (*SynonymSet, error)
func (*UnimplementedSynonymSetServiceServer) ListSynonymSets(context.Context, *ListSynonymSetsRequest) (*ListSynonymSetsResponse, error)
func (*UnimplementedSynonymSetServiceServer) UpdateSynonymSet(context.Context, *UpdateSynonymSetRequest) (*SynonymSet, error)
Metadata object for UpdateDocument request (currently empty).
type UpdateDocumentMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateDocumentMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDocumentMetadata.ProtoReflect.Descriptor instead.
func (*UpdateDocumentMetadata) ProtoMessage()
func (x *UpdateDocumentMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateDocumentMetadata) Reset()
func (x *UpdateDocumentMetadata) String() string
Request message for DocumentService.UpdateDocument.
type UpdateDocumentRequest struct {
// Required. The name of the document to update.
// Format:
// projects/{project_number}/locations/{location}/documents/{document_id}
// or
// projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The document to update.
Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
// The meta information collected about the end user, used to enforce access
// control for the service.
RequestMetadata *RequestMetadata `protobuf:"bytes,3,opt,name=request_metadata,json=requestMetadata,proto3" json:"request_metadata,omitempty"`
// Request Option for processing Cloud AI Document in CW Document.
CloudAiDocumentOption *CloudAIDocumentOption `protobuf:"bytes,5,opt,name=cloud_ai_document_option,json=cloudAiDocumentOption,proto3" json:"cloud_ai_document_option,omitempty"`
// Options for the update operation.
UpdateOptions *UpdateOptions `protobuf:"bytes,6,opt,name=update_options,json=updateOptions,proto3" json:"update_options,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDocumentRequest) GetCloudAiDocumentOption() *CloudAIDocumentOption
func (x *UpdateDocumentRequest) GetDocument() *Document
func (x *UpdateDocumentRequest) GetName() string
func (x *UpdateDocumentRequest) GetRequestMetadata() *RequestMetadata
func (x *UpdateDocumentRequest) GetUpdateOptions() *UpdateOptions
func (*UpdateDocumentRequest) ProtoMessage()
func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDocumentRequest) Reset()
func (x *UpdateDocumentRequest) String() string
Response message for DocumentService.UpdateDocument.
type UpdateDocumentResponse struct {
// Updated document after executing update request.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// Output from Rule Engine recording the rule evaluator and action executor's
// output.
//
// Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto
RuleEngineOutput *RuleEngineOutput `protobuf:"bytes,2,opt,name=rule_engine_output,json=ruleEngineOutput,proto3" json:"rule_engine_output,omitempty"`
// Additional information for the API invocation, such as the request tracking
// id.
Metadata *ResponseMetadata `protobuf:"bytes,3,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDocumentResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDocumentResponse.ProtoReflect.Descriptor instead.
func (x *UpdateDocumentResponse) GetDocument() *Document
func (x *UpdateDocumentResponse) GetMetadata() *ResponseMetadata
func (x *UpdateDocumentResponse) GetRuleEngineOutput() *RuleEngineOutput
func (*UpdateDocumentResponse) ProtoMessage()
func (x *UpdateDocumentResponse) ProtoReflect() protoreflect.Message
func (x *UpdateDocumentResponse) Reset()
func (x *UpdateDocumentResponse) String() string
Request message for DocumentSchemaService.UpdateDocumentSchema.
type UpdateDocumentSchemaRequest struct {
// Required. The name of the document schema to update.
// Format:
// projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The document schema to update with.
DocumentSchema *DocumentSchema `protobuf:"bytes,2,opt,name=document_schema,json=documentSchema,proto3" json:"document_schema,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDocumentSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDocumentSchemaRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDocumentSchemaRequest) GetDocumentSchema() *DocumentSchema
func (x *UpdateDocumentSchemaRequest) GetName() string
func (*UpdateDocumentSchemaRequest) ProtoMessage()
func (x *UpdateDocumentSchemaRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDocumentSchemaRequest) Reset()
func (x *UpdateDocumentSchemaRequest) String() string
Options for Update operations.
type UpdateOptions struct {
// Type for update.
UpdateType UpdateType `protobuf:"varint,1,opt,name=update_type,json=updateType,proto3,enum=google.cloud.contentwarehouse.v1.UpdateType" json:"update_type,omitempty"`
// Field mask for merging Document fields.
// For the `FieldMask` definition,
// see
// https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Options for merging.
MergeFieldsOptions *MergeFieldsOptions `protobuf:"bytes,3,opt,name=merge_fields_options,json=mergeFieldsOptions,proto3" json:"merge_fields_options,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateOptions) Descriptor() ([]byte, []int)
Deprecated: Use UpdateOptions.ProtoReflect.Descriptor instead.
func (x *UpdateOptions) GetMergeFieldsOptions() *MergeFieldsOptions
func (x *UpdateOptions) GetUpdateMask() *fieldmaskpb.FieldMask
func (x *UpdateOptions) GetUpdateType() UpdateType
func (*UpdateOptions) ProtoMessage()
func (x *UpdateOptions) ProtoReflect() protoreflect.Message
func (x *UpdateOptions) Reset()
func (x *UpdateOptions) String() string
Request message for RuleSetService.UpdateRuleSet.
type UpdateRuleSetRequest struct {
// Required. The name of the rule set to update.
// Format:
// projects/{project_number}/locations/{location}/ruleSets/{rule_set_id}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The rule set to update.
RuleSet *RuleSet `protobuf:"bytes,2,opt,name=rule_set,json=ruleSet,proto3" json:"rule_set,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateRuleSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateRuleSetRequest.ProtoReflect.Descriptor instead.
func (x *UpdateRuleSetRequest) GetName() string
func (x *UpdateRuleSetRequest) GetRuleSet() *RuleSet
func (*UpdateRuleSetRequest) ProtoMessage()
func (x *UpdateRuleSetRequest) ProtoReflect() protoreflect.Message
func (x *UpdateRuleSetRequest) Reset()
func (x *UpdateRuleSetRequest) String() string
Request message for SynonymSetService.UpdateSynonymSet. Removes the SynonymSet for the specified context and replaces it with the SynonymSet in this request.
type UpdateSynonymSetRequest struct {
// Required. The name of the synonymSet to update
// Format:
// projects/{project_number}/locations/{location}/synonymSets/{context}.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The synonymSet to be updated for the customer
SynonymSet *SynonymSet `protobuf:"bytes,2,opt,name=synonym_set,json=synonymSet,proto3" json:"synonym_set,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateSynonymSetRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateSynonymSetRequest.ProtoReflect.Descriptor instead.
func (x *UpdateSynonymSetRequest) GetName() string
func (x *UpdateSynonymSetRequest) GetSynonymSet() *SynonymSet
func (*UpdateSynonymSetRequest) ProtoMessage()
func (x *UpdateSynonymSetRequest) ProtoReflect() protoreflect.Message
func (x *UpdateSynonymSetRequest) Reset()
func (x *UpdateSynonymSetRequest) String() string
Update type of the requests.
type UpdateType int32
const (
// Defaults to full replace behavior, ie. FULL_REPLACE.
UpdateType_UPDATE_TYPE_UNSPECIFIED UpdateType = 0
// Fully replace all the fields. Any field masks will be ignored.
UpdateType_UPDATE_TYPE_REPLACE UpdateType = 1
// Merge the fields into the existing entities.
UpdateType_UPDATE_TYPE_MERGE UpdateType = 2
// Inserts the properties by names.
UpdateType_UPDATE_TYPE_INSERT_PROPERTIES_BY_NAMES UpdateType = 3
// Replace the properties by names.
UpdateType_UPDATE_TYPE_REPLACE_PROPERTIES_BY_NAMES UpdateType = 4
// Delete the properties by names.
UpdateType_UPDATE_TYPE_DELETE_PROPERTIES_BY_NAMES UpdateType = 5
)
func (UpdateType) Descriptor() protoreflect.EnumDescriptor
func (x UpdateType) Enum() *UpdateType
func (UpdateType) EnumDescriptor() ([]byte, []int)
Deprecated: Use UpdateType.Descriptor instead.
func (x UpdateType) Number() protoreflect.EnumNumber
func (x UpdateType) String() string
func (UpdateType) Type() protoreflect.EnumType
type UserInfo struct {
// A unique user identification string, as determined by the client.
// The maximum number of allowed characters is 255.
// Allowed characters include numbers 0 to 9, uppercase and lowercase letters,
// and restricted special symbols (:, @, +, -, _, ~)
// The format is "user:xxxx@example.com";
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// The unique group identifications which the user is belong to.
// The format is "group:yyyy@example.com";
GroupIds []string `protobuf:"bytes,2,rep,name=group_ids,json=groupIds,proto3" json:"group_ids,omitempty"`
// contains filtered or unexported fields
}
func (*UserInfo) Descriptor() ([]byte, []int)
Deprecated: Use UserInfo.ProtoReflect.Descriptor instead.
func (x *UserInfo) GetGroupIds() []string
func (x *UserInfo) GetId() string
func (*UserInfo) ProtoMessage()
func (x *UserInfo) ProtoReflect() protoreflect.Message
func (x *UserInfo) Reset()
func (x *UserInfo) String() string
`Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
type Value struct {
// The kind of value.
//
// Types that are assignable to Kind:
//
// *Value_FloatValue
// *Value_IntValue
// *Value_StringValue
// *Value_EnumValue
// *Value_DatetimeValue
// *Value_TimestampValue
// *Value_BooleanValue
Kind isValue_Kind `protobuf_oneof:"kind"`
// contains filtered or unexported fields
}
func (*Value) Descriptor() ([]byte, []int)
Deprecated: Use Value.ProtoReflect.Descriptor instead.
func (x *Value) GetBooleanValue() bool
func (x *Value) GetDatetimeValue() *datetime.DateTime
func (x *Value) GetEnumValue() *EnumValue
func (x *Value) GetFloatValue() float32
func (x *Value) GetIntValue() int32
func (m *Value) GetKind() isValue_Kind
func (x *Value) GetStringValue() string
func (x *Value) GetTimestampValue() *TimestampValue
func (*Value) ProtoMessage()
func (x *Value) ProtoReflect() protoreflect.Message
func (x *Value) Reset()
func (x *Value) String() string
type Value_BooleanValue struct {
// Represents a boolean value.
BooleanValue bool `protobuf:"varint,7,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}
type Value_DatetimeValue struct {
// Represents a datetime value.
DatetimeValue *datetime.DateTime `protobuf:"bytes,5,opt,name=datetime_value,json=datetimeValue,proto3,oneof"`
}
type Value_EnumValue struct {
// Represents an enum value.
EnumValue *EnumValue `protobuf:"bytes,4,opt,name=enum_value,json=enumValue,proto3,oneof"`
}
type Value_FloatValue struct {
// Represents a float value.
FloatValue float32 `protobuf:"fixed32,1,opt,name=float_value,json=floatValue,proto3,oneof"`
}
type Value_IntValue struct {
// Represents a integer value.
IntValue int32 `protobuf:"varint,2,opt,name=int_value,json=intValue,proto3,oneof"`
}
type Value_StringValue struct {
// Represents a string value.
StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}
type Value_TimestampValue struct {
// Represents a timestamp value.
TimestampValue *TimestampValue `protobuf:"bytes,6,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}