Represents a DocumentQuery.
Package
@google-cloud/contentwarehouseConstructors
(constructor)(properties)
constructor(properties?: google.cloud.contentwarehouse.v1.IDocumentQuery);
Constructs a new DocumentQuery.
Parameter | |
---|---|
Name | Description |
properties |
IDocumentQuery
Properties to set |
Properties
customPropertyFilter
public customPropertyFilter: string;
DocumentQuery customPropertyFilter.
customWeightsMetadata
public customWeightsMetadata?: (google.cloud.contentwarehouse.v1.ICustomWeightsMetadata|null);
DocumentQuery customWeightsMetadata.
documentCreatorFilter
public documentCreatorFilter: string[];
DocumentQuery documentCreatorFilter.
documentNameFilter
public documentNameFilter: string[];
DocumentQuery documentNameFilter.
documentSchemaNames
public documentSchemaNames: string[];
DocumentQuery documentSchemaNames.
fileTypeFilter
public fileTypeFilter?: (google.cloud.contentwarehouse.v1.IFileTypeFilter|null);
DocumentQuery fileTypeFilter.
folderNameFilter
public folderNameFilter: string;
DocumentQuery folderNameFilter.
isNlQuery
public isNlQuery: boolean;
DocumentQuery isNlQuery.
propertyFilter
public propertyFilter: google.cloud.contentwarehouse.v1.IPropertyFilter[];
DocumentQuery propertyFilter.
query
public query: string;
DocumentQuery query.
queryContext
public queryContext: string[];
DocumentQuery queryContext.
timeFilters
public timeFilters: google.cloud.contentwarehouse.v1.ITimeFilter[];
DocumentQuery timeFilters.
Methods
create(properties)
public static create(properties?: google.cloud.contentwarehouse.v1.IDocumentQuery): google.cloud.contentwarehouse.v1.DocumentQuery;
Creates a new DocumentQuery instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IDocumentQuery
Properties to set |
Returns | |
---|---|
Type | Description |
DocumentQuery | DocumentQuery instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.contentwarehouse.v1.DocumentQuery;
Decodes a DocumentQuery message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
DocumentQuery | DocumentQuery |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.DocumentQuery;
Decodes a DocumentQuery message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
DocumentQuery | DocumentQuery |
encode(message, writer)
public static encode(message: google.cloud.contentwarehouse.v1.IDocumentQuery, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DocumentQuery message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IDocumentQuery
DocumentQuery message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IDocumentQuery, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified DocumentQuery message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IDocumentQuery
DocumentQuery message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.DocumentQuery;
Creates a DocumentQuery message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
DocumentQuery | DocumentQuery |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for DocumentQuery
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this DocumentQuery to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.contentwarehouse.v1.DocumentQuery, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a DocumentQuery message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
DocumentQuery
DocumentQuery |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a DocumentQuery message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|