UNPKG

@google-cloud/contentwarehouse

Version:
1,208 lines 259 kB
{ "nested": { "google": { "nested": { "cloud": { "nested": { "contentwarehouse": { "nested": { "v1": { "options": { "csharp_namespace": "Google.Cloud.ContentWarehouse.V1", "go_package": "cloud.google.com/go/contentwarehouse/apiv1/contentwarehousepb;contentwarehousepb", "java_multiple_files": true, "java_outer_classname": "SynonymSetServiceRequestProto", "java_package": "com.google.cloud.contentwarehouse.v1", "php_namespace": "Google\\Cloud\\ContentWarehouse\\V1", "ruby_package": "Google::Cloud::ContentWarehouse::V1", "(google.api.resource_definition).type": "cloudfunctions.googleapis.com/CloudFunction", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/functions/{function}" }, "nested": { "CreateDocumentMetadata": { "fields": {} }, "UpdateDocumentMetadata": { "fields": {} }, "RequestMetadata": { "fields": { "userInfo": { "type": "UserInfo", "id": 1 } } }, "ResponseMetadata": { "fields": { "requestId": { "type": "string", "id": 1 } } }, "UserInfo": { "fields": { "id": { "type": "string", "id": 1 }, "groupIds": { "rule": "repeated", "type": "string", "id": 2 } } }, "UpdateOptions": { "fields": { "updateType": { "type": "UpdateType", "id": 1 }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2 }, "mergeFieldsOptions": { "type": "MergeFieldsOptions", "id": 3 } } }, "MergeFieldsOptions": { "oneofs": { "_replaceMessageFields": { "oneof": [ "replaceMessageFields" ] }, "_replaceRepeatedFields": { "oneof": [ "replaceRepeatedFields" ] } }, "fields": { "replaceMessageFields": { "type": "bool", "id": 1, "options": { "proto3_optional": true } }, "replaceRepeatedFields": { "type": "bool", "id": 2, "options": { "proto3_optional": true } } } }, "UpdateType": { "values": { "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, "UPDATE_TYPE_MERGE_AND_REPLACE_OR_INSERT_PROPERTIES_BY_NAMES": 6 } }, "DatabaseType": { "valuesOptions": { "DB_CLOUD_SQL_POSTGRES": { "deprecated": true } }, "values": { "DB_UNKNOWN": 0, "DB_INFRA_SPANNER": 1, "DB_CLOUD_SQL_POSTGRES": 2 } }, "AccessControlMode": { "values": { "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 } }, "DocumentCreatorDefaultRole": { "values": { "DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED": 0, "DOCUMENT_ADMIN": 1, "DOCUMENT_EDITOR": 2, "DOCUMENT_VIEWER": 3 } }, "Document": { "options": { "(google.api.resource).type": "contentwarehouse.googleapis.com/Document", "(google.api.resource).pattern": "projects/{project}/locations/{location}/documents/referenceId/{reference_id}" }, "oneofs": { "structuredContent": { "oneof": [ "plainText", "cloudAiDocument" ] }, "rawDocument": { "oneof": [ "rawDocumentPath", "inlineRawDocument" ] } }, "fields": { "name": { "type": "string", "id": 1 }, "referenceId": { "type": "string", "id": 11 }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "title": { "type": "string", "id": 18 }, "displayUri": { "type": "string", "id": 17 }, "documentSchemaName": { "type": "string", "id": 3, "options": { "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/DocumentSchema" } }, "plainText": { "type": "string", "id": 15 }, "cloudAiDocument": { "type": "google.cloud.documentai.v1.Document", "id": 4 }, "structuredContentUri": { "type": "string", "id": 16, "options": { "deprecated": true } }, "rawDocumentPath": { "type": "string", "id": 5 }, "inlineRawDocument": { "type": "bytes", "id": 6 }, "properties": { "rule": "repeated", "type": "Property", "id": 7 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 8, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "createTime": { "type": "google.protobuf.Timestamp", "id": 9, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "rawDocumentFileType": { "type": "RawDocumentFileType", "id": 10 }, "asyncEnabled": { "type": "bool", "id": 12, "options": { "deprecated": true } }, "contentCategory": { "type": "ContentCategory", "id": 20 }, "textExtractionDisabled": { "type": "bool", "id": 19, "options": { "deprecated": true } }, "textExtractionEnabled": { "type": "bool", "id": 21 }, "creator": { "type": "string", "id": 13 }, "updater": { "type": "string", "id": 14 }, "dispositionTime": { "type": "google.protobuf.Timestamp", "id": 22, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "legalHold": { "type": "bool", "id": 23, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "DocumentReference": { "fields": { "documentName": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Document" } }, "displayName": { "type": "string", "id": 2 }, "snippet": { "type": "string", "id": 3 }, "documentIsFolder": { "type": "bool", "id": 4 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "createTime": { "type": "google.protobuf.Timestamp", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "deleteTime": { "type": "google.protobuf.Timestamp", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "documentIsRetentionFolder": { "type": "bool", "id": 8 }, "documentIsLegalHoldFolder": { "type": "bool", "id": 9 } } }, "Property": { "oneofs": { "values": { "oneof": [ "integerValues", "floatValues", "textValues", "enumValues", "propertyValues", "dateTimeValues", "mapProperty", "timestampValues" ] } }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "integerValues": { "type": "IntegerArray", "id": 2 }, "floatValues": { "type": "FloatArray", "id": 3 }, "textValues": { "type": "TextArray", "id": 4 }, "enumValues": { "type": "EnumArray", "id": 5 }, "propertyValues": { "type": "PropertyArray", "id": 6 }, "dateTimeValues": { "type": "DateTimeArray", "id": 7 }, "mapProperty": { "type": "MapProperty", "id": 8 }, "timestampValues": { "type": "TimestampArray", "id": 9 } } }, "IntegerArray": { "fields": { "values": { "rule": "repeated", "type": "int32", "id": 1 } } }, "FloatArray": { "fields": { "values": { "rule": "repeated", "type": "float", "id": 1 } } }, "TextArray": { "fields": { "values": { "rule": "repeated", "type": "string", "id": 1 } } }, "EnumArray": { "fields": { "values": { "rule": "repeated", "type": "string", "id": 1 } } }, "DateTimeArray": { "fields": { "values": { "rule": "repeated", "type": "google.type.DateTime", "id": 1 } } }, "TimestampArray": { "fields": { "values": { "rule": "repeated", "type": "TimestampValue", "id": 1 } } }, "TimestampValue": { "oneofs": { "value": { "oneof": [ "timestampValue", "textValue" ] } }, "fields": { "timestampValue": { "type": "google.protobuf.Timestamp", "id": 1 }, "textValue": { "type": "string", "id": 2 } } }, "PropertyArray": { "fields": { "properties": { "rule": "repeated", "type": "Property", "id": 1 } } }, "MapProperty": { "fields": { "fields": { "keyType": "string", "type": "Value", "id": 1 } } }, "Value": { "oneofs": { "kind": { "oneof": [ "floatValue", "intValue", "stringValue", "enumValue", "datetimeValue", "timestampValue", "booleanValue" ] } }, "fields": { "floatValue": { "type": "float", "id": 1 }, "intValue": { "type": "int32", "id": 2 }, "stringValue": { "type": "string", "id": 3 }, "enumValue": { "type": "EnumValue", "id": 4 }, "datetimeValue": { "type": "google.type.DateTime", "id": 5 }, "timestampValue": { "type": "TimestampValue", "id": 6 }, "booleanValue": { "type": "bool", "id": 7 } } }, "EnumValue": { "fields": { "value": { "type": "string", "id": 1 } } }, "RawDocumentFileType": { "values": { "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, "RAW_DOCUMENT_FILE_TYPE_TIFF": 6 } }, "ContentCategory": { "values": { "CONTENT_CATEGORY_UNSPECIFIED": 0, "CONTENT_CATEGORY_IMAGE": 1, "CONTENT_CATEGORY_AUDIO": 2, "CONTENT_CATEGORY_VIDEO": 3 } }, "DocumentLinkService": { "options": { "(google.api.default_host)": "contentwarehouse.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "ListLinkedTargets": { "requestType": "ListLinkedTargetsRequest", "responseType": "ListLinkedTargetsResponse", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*/documents/*}/linkedTargets", "(google.api.http).body": "*", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*/documents/*}/linkedTargets", "body": "*" } }, { "(google.api.method_signature)": "parent" } ] }, "ListLinkedSources": { "requestType": "ListLinkedSourcesRequest", "responseType": "ListLinkedSourcesResponse", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*/documents/*}/linkedSources", "(google.api.http).body": "*", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*/documents/*}/linkedSources", "body": "*" } }, { "(google.api.method_signature)": "parent" } ] }, "CreateDocumentLink": { "requestType": "CreateDocumentLinkRequest", "responseType": "DocumentLink", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*/documents/*}/documentLinks", "(google.api.http).body": "*", "(google.api.method_signature)": "parent,document_link" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*/documents/*}/documentLinks", "body": "*" } }, { "(google.api.method_signature)": "parent,document_link" } ] }, "DeleteDocumentLink": { "requestType": "DeleteDocumentLinkRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).post": "/v1/{name=projects/*/locations/*/documents/*/documentLinks/*}:delete", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/locations/*/documents/*/documentLinks/*}:delete", "body": "*" } }, { "(google.api.method_signature)": "name" } ] } } }, "ListLinkedTargetsResponse": { "fields": { "documentLinks": { "rule": "repeated", "type": "DocumentLink", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "ListLinkedTargetsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Document" } }, "requestMetadata": { "type": "RequestMetadata", "id": 2 } } }, "ListLinkedSourcesResponse": { "fields": { "documentLinks": { "rule": "repeated", "type": "DocumentLink", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "ListLinkedSourcesRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Document" } }, "pageSize": { "type": "int32", "id": 3 }, "pageToken": { "type": "string", "id": 4 }, "requestMetadata": { "type": "RequestMetadata", "id": 2 } } }, "DocumentLink": { "options": { "(google.api.resource).type": "contentwarehouse.googleapis.com/DocumentLink", "(google.api.resource).pattern": "projects/{project}/locations/{location}/documents/{document}/documentLinks/{document_link}" }, "fields": { "name": { "type": "string", "id": 1 }, "sourceDocumentReference": { "type": "DocumentReference", "id": 2 }, "targetDocumentReference": { "type": "DocumentReference", "id": 3 }, "description": { "type": "string", "id": 4 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "createTime": { "type": "google.protobuf.Timestamp", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "state": { "type": "State", "id": 7 } }, "nested": { "State": { "values": { "STATE_UNSPECIFIED": 0, "ACTIVE": 1, "SOFT_DELETED": 2 } } } }, "CreateDocumentLinkRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Document" } }, "documentLink": { "type": "DocumentLink", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "requestMetadata": { "type": "RequestMetadata", "id": 3 } } }, "DeleteDocumentLinkRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/DocumentLink" } }, "requestMetadata": { "type": "RequestMetadata", "id": 2 } } }, "DocumentSchema": { "options": { "(google.api.resource).type": "contentwarehouse.googleapis.com/DocumentSchema", "(google.api.resource).pattern": "projects/{project}/locations/{location}/documentSchemas/{document_schema}" }, "fields": { "name": { "type": "string", "id": 1 }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "propertyDefinitions": { "rule": "repeated", "type": "PropertyDefinition", "id": 3 }, "documentIsFolder": { "type": "bool", "id": 4 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "createTime": { "type": "google.protobuf.Timestamp", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "description": { "type": "string", "id": 7 } } }, "PropertyDefinition": { "oneofs": { "valueTypeOptions": { "oneof": [ "integerTypeOptions", "floatTypeOptions", "textTypeOptions", "propertyTypeOptions", "enumTypeOptions", "dateTimeTypeOptions", "mapTypeOptions", "timestampTypeOptions" ] } }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "displayName": { "type": "string", "id": 12 }, "isRepeatable": { "type": "bool", "id": 2 }, "isFilterable": { "type": "bool", "id": 3 }, "isSearchable": { "type": "bool", "id": 4 }, "isMetadata": { "type": "bool", "id": 5 }, "isRequired": { "type": "bool", "id": 14 }, "retrievalImportance": { "type": "RetrievalImportance", "id": 18 }, "integerTypeOptions": { "type": "IntegerTypeOptions", "id": 7 }, "floatTypeOptions": { "type": "FloatTypeOptions", "id": 8 }, "textTypeOptions": { "type": "TextTypeOptions", "id": 9 }, "propertyTypeOptions": { "type": "PropertyTypeOptions", "id": 10 }, "enumTypeOptions": { "type": "EnumTypeOptions", "id": 11 }, "dateTimeTypeOptions": { "type": "DateTimeTypeOptions", "id": 13 }, "mapTypeOptions": { "type": "MapTypeOptions", "id": 15 }, "timestampTypeOptions": { "type": "TimestampTypeOptions", "id": 16 }, "schemaSources": { "rule": "repeated", "type": "SchemaSource", "id": 19 } }, "nested": { "RetrievalImportance": { "values": { "RETRIEVAL_IMPORTANCE_UNSPECIFIED": 0, "HIGHEST": 1, "HIGHER": 2, "HIGH": 3, "MEDIUM": 4, "LOW": 5, "LOWEST": 6 } }, "SchemaSource": { "fields": { "name": { "type": "string", "id": 1 }, "processorType": { "type": "string", "id": 2 } } } } }, "IntegerTypeOptions": { "fields": {} }, "FloatTypeOptions": { "fields": {} }, "TextTypeOptions": { "fields": {} }, "DateTimeTypeOptions": { "fields": {} }, "MapTypeOptions": { "fields": {} }, "TimestampTypeOptions": { "fields": {} }, "PropertyTypeOptions": { "fields": { "propertyDefinitions": { "rule": "repeated", "type": "PropertyDefinition", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "EnumTypeOptions": { "fields": { "possibleValues": { "rule": "repeated", "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "validationCheckDisabled": { "type": "bool", "id": 2 } } }, "DocumentSchemaService": { "options": { "(google.api.default_host)": "contentwarehouse.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "CreateDocumentSchema": { "requestType": "CreateDocumentSchemaRequest", "responseType": "DocumentSchema", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*}/documentSchemas", "(google.api.http).body": "document_schema", "(google.api.method_signature)": "parent,document_schema" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*}/documentSchemas", "body": "document_schema" } }, { "(google.api.method_signature)": "parent,document_schema" } ] }, "UpdateDocumentSchema": { "requestType": "UpdateDocumentSchemaRequest", "responseType": "DocumentSchema", "options": { "(google.api.http).patch": "/v1/{name=projects/*/locations/*/documentSchemas/*}", "(google.api.http).body": "*", "(google.api.method_signature)": "name,document_schema" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v1/{name=projects/*/locations/*/documentSchemas/*}", "body": "*" } }, { "(google.api.method_signature)": "name,document_schema" } ] }, "GetDocumentSchema": { "requestType": "GetDocumentSchemaRequest", "responseType": "DocumentSchema", "options": { "(google.api.http).get": "/v1/{name=projects/*/locations/*/documentSchemas/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/locations/*/documentSchemas/*}" } }, { "(google.api.method_signature)": "name" } ] }, "DeleteDocumentSchema": { "requestType": "DeleteDocumentSchemaRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v1/{name=projects/*/locations/*/documentSchemas/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=projects/*/locations/*/documentSchemas/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListDocumentSchemas": { "requestType": "ListDocumentSchemasRequest", "responseType": "ListDocumentSchemasResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/locations/*}/documentSchemas", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/locations/*}/documentSchemas" } }, { "(google.api.method_signature)": "parent" } ] } } }, "CreateDocumentSchemaRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Location" } }, "documentSchema": { "type": "DocumentSchema", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "GetDocumentSchemaRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/DocumentSchema" } } } }, "UpdateDocumentSchemaRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/DocumentSchema" } }, "documentSchema": { "type": "DocumentSchema", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "DeleteDocumentSchemaRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/DocumentSchema" } } } }, "ListDocumentSchemasRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "contentwarehouse.googleapis.com/Location" } }, "pageSize": { "type": "int32", "id": 2 }, "pageToken": { "type": "string", "id": 3 } } }, "ListDocumentSchemasResponse": { "fields": { "documentSchemas": { "rule": "repeated", "type": "DocumentSchema", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "DocumentService": { "options": { "(google.api.default_host)"