@google-cloud/contentwarehouse
Version:
Document AI Warehouse client for Node.js
956 lines (781 loc) • 1.61 MB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace contentwarehouse. */
namespace contentwarehouse {
/** Namespace v1. */
namespace v1 {
/** Properties of a CreateDocumentMetadata. */
interface ICreateDocumentMetadata {
}
/** Represents a CreateDocumentMetadata. */
class CreateDocumentMetadata implements ICreateDocumentMetadata {
/**
* Constructs a new CreateDocumentMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.ICreateDocumentMetadata);
/**
* Creates a new CreateDocumentMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns CreateDocumentMetadata instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.ICreateDocumentMetadata): google.cloud.contentwarehouse.v1.CreateDocumentMetadata;
/**
* Encodes the specified CreateDocumentMetadata message. Does not implicitly {@link google.cloud.contentwarehouse.v1.CreateDocumentMetadata.verify|verify} messages.
* @param message CreateDocumentMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.ICreateDocumentMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CreateDocumentMetadata message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.CreateDocumentMetadata.verify|verify} messages.
* @param message CreateDocumentMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.ICreateDocumentMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CreateDocumentMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CreateDocumentMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.CreateDocumentMetadata;
/**
* Decodes a CreateDocumentMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CreateDocumentMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.CreateDocumentMetadata;
/**
* Verifies a CreateDocumentMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a CreateDocumentMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CreateDocumentMetadata
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.CreateDocumentMetadata;
/**
* Creates a plain object from a CreateDocumentMetadata message. Also converts values to other types if specified.
* @param message CreateDocumentMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.CreateDocumentMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CreateDocumentMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CreateDocumentMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an UpdateDocumentMetadata. */
interface IUpdateDocumentMetadata {
}
/** Represents an UpdateDocumentMetadata. */
class UpdateDocumentMetadata implements IUpdateDocumentMetadata {
/**
* Constructs a new UpdateDocumentMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IUpdateDocumentMetadata);
/**
* Creates a new UpdateDocumentMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateDocumentMetadata instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IUpdateDocumentMetadata): google.cloud.contentwarehouse.v1.UpdateDocumentMetadata;
/**
* Encodes the specified UpdateDocumentMetadata message. Does not implicitly {@link google.cloud.contentwarehouse.v1.UpdateDocumentMetadata.verify|verify} messages.
* @param message UpdateDocumentMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IUpdateDocumentMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateDocumentMetadata message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.UpdateDocumentMetadata.verify|verify} messages.
* @param message UpdateDocumentMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IUpdateDocumentMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateDocumentMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateDocumentMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.UpdateDocumentMetadata;
/**
* Decodes an UpdateDocumentMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateDocumentMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.UpdateDocumentMetadata;
/**
* Verifies an UpdateDocumentMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an UpdateDocumentMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateDocumentMetadata
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.UpdateDocumentMetadata;
/**
* Creates a plain object from an UpdateDocumentMetadata message. Also converts values to other types if specified.
* @param message UpdateDocumentMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.UpdateDocumentMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UpdateDocumentMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UpdateDocumentMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a RequestMetadata. */
interface IRequestMetadata {
/** RequestMetadata userInfo */
userInfo?: (google.cloud.contentwarehouse.v1.IUserInfo|null);
}
/** Represents a RequestMetadata. */
class RequestMetadata implements IRequestMetadata {
/**
* Constructs a new RequestMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IRequestMetadata);
/** RequestMetadata userInfo. */
public userInfo?: (google.cloud.contentwarehouse.v1.IUserInfo|null);
/**
* Creates a new RequestMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns RequestMetadata instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IRequestMetadata): google.cloud.contentwarehouse.v1.RequestMetadata;
/**
* Encodes the specified RequestMetadata message. Does not implicitly {@link google.cloud.contentwarehouse.v1.RequestMetadata.verify|verify} messages.
* @param message RequestMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IRequestMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified RequestMetadata message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.RequestMetadata.verify|verify} messages.
* @param message RequestMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IRequestMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a RequestMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns RequestMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.RequestMetadata;
/**
* Decodes a RequestMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns RequestMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.RequestMetadata;
/**
* Verifies a RequestMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a RequestMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns RequestMetadata
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.RequestMetadata;
/**
* Creates a plain object from a RequestMetadata message. Also converts values to other types if specified.
* @param message RequestMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.RequestMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this RequestMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for RequestMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ResponseMetadata. */
interface IResponseMetadata {
/** ResponseMetadata requestId */
requestId?: (string|null);
}
/** Represents a ResponseMetadata. */
class ResponseMetadata implements IResponseMetadata {
/**
* Constructs a new ResponseMetadata.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IResponseMetadata);
/** ResponseMetadata requestId. */
public requestId: string;
/**
* Creates a new ResponseMetadata instance using the specified properties.
* @param [properties] Properties to set
* @returns ResponseMetadata instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IResponseMetadata): google.cloud.contentwarehouse.v1.ResponseMetadata;
/**
* Encodes the specified ResponseMetadata message. Does not implicitly {@link google.cloud.contentwarehouse.v1.ResponseMetadata.verify|verify} messages.
* @param message ResponseMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IResponseMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ResponseMetadata message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.ResponseMetadata.verify|verify} messages.
* @param message ResponseMetadata message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IResponseMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ResponseMetadata message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ResponseMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.ResponseMetadata;
/**
* Decodes a ResponseMetadata message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ResponseMetadata
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.ResponseMetadata;
/**
* Verifies a ResponseMetadata message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ResponseMetadata message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ResponseMetadata
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.ResponseMetadata;
/**
* Creates a plain object from a ResponseMetadata message. Also converts values to other types if specified.
* @param message ResponseMetadata
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.ResponseMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ResponseMetadata to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ResponseMetadata
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a UserInfo. */
interface IUserInfo {
/** UserInfo id */
id?: (string|null);
/** UserInfo groupIds */
groupIds?: (string[]|null);
}
/** Represents a UserInfo. */
class UserInfo implements IUserInfo {
/**
* Constructs a new UserInfo.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IUserInfo);
/** UserInfo id. */
public id: string;
/** UserInfo groupIds. */
public groupIds: string[];
/**
* Creates a new UserInfo instance using the specified properties.
* @param [properties] Properties to set
* @returns UserInfo instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IUserInfo): google.cloud.contentwarehouse.v1.UserInfo;
/**
* Encodes the specified UserInfo message. Does not implicitly {@link google.cloud.contentwarehouse.v1.UserInfo.verify|verify} messages.
* @param message UserInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IUserInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UserInfo message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.UserInfo.verify|verify} messages.
* @param message UserInfo message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IUserInfo, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a UserInfo message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UserInfo
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.UserInfo;
/**
* Decodes a UserInfo message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UserInfo
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.UserInfo;
/**
* Verifies a UserInfo message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a UserInfo message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UserInfo
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.UserInfo;
/**
* Creates a plain object from a UserInfo message. Also converts values to other types if specified.
* @param message UserInfo
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.UserInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UserInfo to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UserInfo
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an UpdateOptions. */
interface IUpdateOptions {
/** UpdateOptions updateType */
updateType?: (google.cloud.contentwarehouse.v1.UpdateType|keyof typeof google.cloud.contentwarehouse.v1.UpdateType|null);
/** UpdateOptions updateMask */
updateMask?: (google.protobuf.IFieldMask|null);
/** UpdateOptions mergeFieldsOptions */
mergeFieldsOptions?: (google.cloud.contentwarehouse.v1.IMergeFieldsOptions|null);
}
/** Represents an UpdateOptions. */
class UpdateOptions implements IUpdateOptions {
/**
* Constructs a new UpdateOptions.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IUpdateOptions);
/** UpdateOptions updateType. */
public updateType: (google.cloud.contentwarehouse.v1.UpdateType|keyof typeof google.cloud.contentwarehouse.v1.UpdateType);
/** UpdateOptions updateMask. */
public updateMask?: (google.protobuf.IFieldMask|null);
/** UpdateOptions mergeFieldsOptions. */
public mergeFieldsOptions?: (google.cloud.contentwarehouse.v1.IMergeFieldsOptions|null);
/**
* Creates a new UpdateOptions instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateOptions instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IUpdateOptions): google.cloud.contentwarehouse.v1.UpdateOptions;
/**
* Encodes the specified UpdateOptions message. Does not implicitly {@link google.cloud.contentwarehouse.v1.UpdateOptions.verify|verify} messages.
* @param message UpdateOptions message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IUpdateOptions, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateOptions message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.UpdateOptions.verify|verify} messages.
* @param message UpdateOptions message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IUpdateOptions, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateOptions message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateOptions
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.UpdateOptions;
/**
* Decodes an UpdateOptions message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateOptions
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.UpdateOptions;
/**
* Verifies an UpdateOptions message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an UpdateOptions message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateOptions
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.UpdateOptions;
/**
* Creates a plain object from an UpdateOptions message. Also converts values to other types if specified.
* @param message UpdateOptions
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.UpdateOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UpdateOptions to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UpdateOptions
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a MergeFieldsOptions. */
interface IMergeFieldsOptions {
/** MergeFieldsOptions replaceMessageFields */
replaceMessageFields?: (boolean|null);
/** MergeFieldsOptions replaceRepeatedFields */
replaceRepeatedFields?: (boolean|null);
}
/** Represents a MergeFieldsOptions. */
class MergeFieldsOptions implements IMergeFieldsOptions {
/**
* Constructs a new MergeFieldsOptions.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IMergeFieldsOptions);
/** MergeFieldsOptions replaceMessageFields. */
public replaceMessageFields?: (boolean|null);
/** MergeFieldsOptions replaceRepeatedFields. */
public replaceRepeatedFields?: (boolean|null);
/**
* Creates a new MergeFieldsOptions instance using the specified properties.
* @param [properties] Properties to set
* @returns MergeFieldsOptions instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IMergeFieldsOptions): google.cloud.contentwarehouse.v1.MergeFieldsOptions;
/**
* Encodes the specified MergeFieldsOptions message. Does not implicitly {@link google.cloud.contentwarehouse.v1.MergeFieldsOptions.verify|verify} messages.
* @param message MergeFieldsOptions message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IMergeFieldsOptions, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified MergeFieldsOptions message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.MergeFieldsOptions.verify|verify} messages.
* @param message MergeFieldsOptions message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IMergeFieldsOptions, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a MergeFieldsOptions message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns MergeFieldsOptions
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.MergeFieldsOptions;
/**
* Decodes a MergeFieldsOptions message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns MergeFieldsOptions
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.MergeFieldsOptions;
/**
* Verifies a MergeFieldsOptions message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a MergeFieldsOptions message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns MergeFieldsOptions
*/
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.MergeFieldsOptions;
/**
* Creates a plain object from a MergeFieldsOptions message. Also converts values to other types if specified.
* @param message MergeFieldsOptions
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.contentwarehouse.v1.MergeFieldsOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this MergeFieldsOptions to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for MergeFieldsOptions
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** UpdateType enum. */
enum UpdateType {
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 enum. */
enum DatabaseType {
DB_UNKNOWN = 0,
DB_INFRA_SPANNER = 1,
DB_CLOUD_SQL_POSTGRES = 2
}
/** AccessControlMode enum. */
enum AccessControlMode {
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 enum. */
enum DocumentCreatorDefaultRole {
DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED = 0,
DOCUMENT_ADMIN = 1,
DOCUMENT_EDITOR = 2,
DOCUMENT_VIEWER = 3
}
/** Properties of a Document. */
interface IDocument {
/** Document name */
name?: (string|null);
/** Document referenceId */
referenceId?: (string|null);
/** Document displayName */
displayName?: (string|null);
/** Document title */
title?: (string|null);
/** Document displayUri */
displayUri?: (string|null);
/** Document documentSchemaName */
documentSchemaName?: (string|null);
/** Document plainText */
plainText?: (string|null);
/** Document cloudAiDocument */
cloudAiDocument?: (google.cloud.documentai.v1.IDocument|null);
/** Document structuredContentUri */
structuredContentUri?: (string|null);
/** Document rawDocumentPath */
rawDocumentPath?: (string|null);
/** Document inlineRawDocument */
inlineRawDocument?: (Uint8Array|Buffer|string|null);
/** Document properties */
properties?: (google.cloud.contentwarehouse.v1.IProperty[]|null);
/** Document updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** Document createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** Document rawDocumentFileType */
rawDocumentFileType?: (google.cloud.contentwarehouse.v1.RawDocumentFileType|keyof typeof google.cloud.contentwarehouse.v1.RawDocumentFileType|null);
/** Document asyncEnabled */
asyncEnabled?: (boolean|null);
/** Document contentCategory */
contentCategory?: (google.cloud.contentwarehouse.v1.ContentCategory|keyof typeof google.cloud.contentwarehouse.v1.ContentCategory|null);
/** Document textExtractionDisabled */
textExtractionDisabled?: (boolean|null);
/** Document textExtractionEnabled */
textExtractionEnabled?: (boolean|null);
/** Document creator */
creator?: (string|null);
/** Document updater */
updater?: (string|null);
/** Document dispositionTime */
dispositionTime?: (google.protobuf.ITimestamp|null);
/** Document legalHold */
legalHold?: (boolean|null);
}
/** Represents a Document. */
class Document implements IDocument {
/**
* Constructs a new Document.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.contentwarehouse.v1.IDocument);
/** Document name. */
public name: string;
/** Document referenceId. */
public referenceId: string;
/** Document displayName. */
public displayName: string;
/** Document title. */
public title: string;
/** Document displayUri. */
public displayUri: string;
/** Document documentSchemaName. */
public documentSchemaName: string;
/** Document plainText. */
public plainText?: (string|null);
/** Document cloudAiDocument. */
public cloudAiDocument?: (google.cloud.documentai.v1.IDocument|null);
/** Document structuredContentUri. */
public structuredContentUri: string;
/** Document rawDocumentPath. */
public rawDocumentPath?: (string|null);
/** Document inlineRawDocument. */
public inlineRawDocument?: (Uint8Array|Buffer|string|null);
/** Document properties. */
public properties: google.cloud.contentwarehouse.v1.IProperty[];
/** Document updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** Document createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Document rawDocumentFileType. */
public rawDocumentFileType: (google.cloud.contentwarehouse.v1.RawDocumentFileType|keyof typeof google.cloud.contentwarehouse.v1.RawDocumentFileType);
/** Document asyncEnabled. */
public asyncEnabled: boolean;
/** Document contentCategory. */
public contentCategory: (google.cloud.contentwarehouse.v1.ContentCategory|keyof typeof google.cloud.contentwarehouse.v1.ContentCategory);
/** Document textExtractionDisabled. */
public textExtractionDisabled: boolean;
/** Document textExtractionEnabled. */
public textExtractionEnabled: boolean;
/** Document creator. */
public creator: string;
/** Document updater. */
public updater: string;
/** Document dispositionTime. */
public dispositionTime?: (google.protobuf.ITimestamp|null);
/** Document legalHold. */
public legalHold: boolean;
/** Document structuredContent. */
public structuredContent?: ("plainText"|"cloudAiDocument");
/** Document rawDocument. */
public rawDocument?: ("rawDocumentPath"|"inlineRawDocument");
/**
* Creates a new Document instance using the specified properties.
* @param [properties] Properties to set
* @returns Document instance
*/
public static create(properties?: google.cloud.contentwarehouse.v1.IDocument): google.cloud.contentwarehouse.v1.Document;
/**
* Encodes the specified Document message. Does not implicitly {@link google.cloud.contentwarehouse.v1.Document.verify|verify} messages.
* @param message Document message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.contentwarehouse.v1.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Document message, length delimited. Does not implicitly {@link google.cloud.contentwarehouse.v1.Document.verify|verify} messages.
* @param message Document message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IDocument, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Document message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Document
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.Document;
/**
* Decodes a Document message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Document
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.Document;
/**
* Verifies a Document message.
* @param message Plain object to verify