Query

import type { Query } from "https://googleapis.deno.dev/v1/vault:v1.ts";

The query definition used for search and export.

interface Query {

accountInfo?: AccountInfo;

calendarOptions?: CalendarOptions;

corpus?:

| "CORPUS_TYPE_UNSPECIFIED"

| "DRIVE"

| "MAIL"

| "GROUPS"

| "HANGOUTS_CHAT"

| "VOICE"

| "CALENDAR";

dataScope?:

| "DATA_SCOPE_UNSPECIFIED"

| "ALL_DATA"

| "HELD_DATA"

| "UNPROCESSED_DATA";

driveOptions?: DriveOptions;

endTime?: Date;

hangoutsChatInfo?: HangoutsChatInfo;

hangoutsChatOptions?: HangoutsChatOptions;

mailOptions?: MailOptions;

method?:

| "SEARCH_METHOD_UNSPECIFIED"

| "ACCOUNT"

| "ORG_UNIT"

| "TEAM_DRIVE"

| "ENTIRE_ORG"

| "ROOM"

| "SITES_URL"

| "SHARED_DRIVE";

orgUnitInfo?: OrgUnitInfo;

searchMethod?:

| "SEARCH_METHOD_UNSPECIFIED"

| "ACCOUNT"

| "ORG_UNIT"

| "TEAM_DRIVE"

| "ENTIRE_ORG"

| "ROOM"

| "SITES_URL"

| "SHARED_DRIVE";

sharedDriveInfo?: SharedDriveInfo;

sitesUrlInfo?: SitesUrlInfo;

startTime?: Date;

teamDriveInfo?: TeamDriveInfo;

terms?: string;

timeZone?: string;

voiceOptions?: VoiceOptions;

}

§Properties

accountInfo?: AccountInfo

[src]

Required when SearchMethod is ACCOUNT.

calendarOptions?: CalendarOptions

[src]

Set Calendar search-specific options.

[src]

The Google Workspace service to search.

dataScope?: "DATA_SCOPE_UNSPECIFIED" | "ALL_DATA" | "HELD_DATA" | "UNPROCESSED_DATA"

[src]

The data source to search.

driveOptions?: DriveOptions

[src]

Set Drive search-specific options.

endTime?: Date

[src]

The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.

hangoutsChatInfo?: HangoutsChatInfo

[src]

Required when SearchMethod is ROOM. (read-only)

hangoutsChatOptions?: HangoutsChatOptions

[src]

Set Chat search-specific options. (read-only)

mailOptions?: MailOptions

[src]

Set Gmail search-specific options.

[src]

The entity to search. This field replaces searchMethod to support shared drives. When searchMethod is TEAM_DRIVE, the response of this field is SHARED_DRIVE.

orgUnitInfo?: OrgUnitInfo

[src]

Required when SearchMethod is ORG_UNIT.

[src]

The search method to use.

sharedDriveInfo?: SharedDriveInfo

[src]

Required when SearchMethod is SHARED_DRIVE.

sitesUrlInfo?: SitesUrlInfo

[src]

Required when SearchMethod is SITES_URL.

startTime?: Date

[src]

The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.

teamDriveInfo?: TeamDriveInfo

[src]

Required when SearchMethod is TEAM_DRIVE.

terms?: string

[src]

Service-specific search operators to filter search results.

timeZone?: string

[src]

The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see Time Zone. For more information about how Vault uses time zones, see the Vault help center.

voiceOptions?: VoiceOptions

[src]

Set Voice search-specific options.