Query (Google Vault API v1-rev20251015-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.vault.v1.model.Query

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Query
extends com.google.api.client.json.GenericJson
```
The query definition used for search and export.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Vault API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Query()

Constructors
Constructor and Description
`Query()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Query`	`clone()`
`AccountInfo`	`getAccountInfo()` Required when SearchMethod is ACCOUNT.
`CalendarOptions`	`getCalendarOptions()` Set Calendar search-specific options.
`String`	`getCorpus()` The Google Workspace service to search.
`String`	`getDataScope()` The data source to search.
`DriveDocumentInfo`	`getDriveDocumentInfo()` Required when SearchMethod is DRIVE_DOCUMENT.
`DriveOptions`	`getDriveOptions()` Set Drive search-specific options.
`String`	`getEndTime()` The end time for the search query.
`GeminiOptions`	`getGeminiOptions()` Set Gemini search-specific options.
`HangoutsChatInfo`	`getHangoutsChatInfo()` Required when SearchMethod is ROOM.
`HangoutsChatOptions`	`getHangoutsChatOptions()` Set Chat search-specific options.
`MailOptions`	`getMailOptions()` Set Gmail search-specific options.
`String`	`getMethod()` The entity to search.
`OrgUnitInfo`	`getOrgUnitInfo()` Required when SearchMethod is ORG_UNIT.
`String`	`getSearchMethod()` The search method to use.
`SharedDriveInfo`	`getSharedDriveInfo()` Required when SearchMethod is SHARED_DRIVE.
`SitesUrlInfo`	`getSitesUrlInfo()` Required when SearchMethod is SITES_URL.
`String`	`getStartTime()` The start time for the search query.
`TeamDriveInfo`	`getTeamDriveInfo()` Required when SearchMethod is TEAM_DRIVE.
`String`	`getTerms()` Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
`String`	`getTimeZone()` The time zone name.
`VoiceOptions`	`getVoiceOptions()` Set Voice search-specific options.
`Query`	`set(String fieldName, Object value)`
`Query`	`setAccountInfo(AccountInfo accountInfo)` Required when SearchMethod is ACCOUNT.
`Query`	`setCalendarOptions(CalendarOptions calendarOptions)` Set Calendar search-specific options.
`Query`	`setCorpus(String corpus)` The Google Workspace service to search.
`Query`	`setDataScope(String dataScope)` The data source to search.
`Query`	`setDriveDocumentInfo(DriveDocumentInfo driveDocumentInfo)` Required when SearchMethod is DRIVE_DOCUMENT.
`Query`	`setDriveOptions(DriveOptions driveOptions)` Set Drive search-specific options.
`Query`	`setEndTime(String endTime)` The end time for the search query.
`Query`	`setGeminiOptions(GeminiOptions geminiOptions)` Set Gemini search-specific options.
`Query`	`setHangoutsChatInfo(HangoutsChatInfo hangoutsChatInfo)` Required when SearchMethod is ROOM.
`Query`	`setHangoutsChatOptions(HangoutsChatOptions hangoutsChatOptions)` Set Chat search-specific options.
`Query`	`setMailOptions(MailOptions mailOptions)` Set Gmail search-specific options.
`Query`	`setMethod(String method)` The entity to search.
`Query`	`setOrgUnitInfo(OrgUnitInfo orgUnitInfo)` Required when SearchMethod is ORG_UNIT.
`Query`	`setSearchMethod(String searchMethod)` The search method to use.
`Query`	`setSharedDriveInfo(SharedDriveInfo sharedDriveInfo)` Required when SearchMethod is SHARED_DRIVE.
`Query`	`setSitesUrlInfo(SitesUrlInfo sitesUrlInfo)` Required when SearchMethod is SITES_URL.
`Query`	`setStartTime(String startTime)` The start time for the search query.
`Query`	`setTeamDriveInfo(TeamDriveInfo teamDriveInfo)` Required when SearchMethod is TEAM_DRIVE.
`Query`	`setTerms(String terms)` Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
`Query`	`setTimeZone(String timeZone)` The time zone name.
`Query`	`setVoiceOptions(VoiceOptions voiceOptions)` Set Voice search-specific options.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Query
```
public Query()
```
- Method Detail
  - getAccountInfo
```
public AccountInfo getAccountInfo()
```
    Required when **SearchMethod** is **ACCOUNT**.
    
    Returns:
    
    value or null for none
  - setAccountInfo
```
public Query setAccountInfo(AccountInfo accountInfo)
```
    Required when **SearchMethod** is **ACCOUNT**.
    
    Parameters:
    
    accountInfo - accountInfo or null for none
  - getCalendarOptions
```
public CalendarOptions getCalendarOptions()
```
    Set Calendar search-specific options.
    
    Returns:
    
    value or null for none
  - setCalendarOptions
```
public Query setCalendarOptions(CalendarOptions calendarOptions)
```
    Set Calendar search-specific options.
    
    Parameters:
    
    calendarOptions - calendarOptions or null for none
  - getCorpus
```
public String getCorpus()
```
    The Google Workspace service to search.
    
    Returns:
    
    value or null for none
  - setCorpus
```
public Query setCorpus(String corpus)
```
    The Google Workspace service to search.
    
    Parameters:
    
    corpus - corpus or null for none
  - getDataScope
```
public String getDataScope()
```
    The data source to search.
    
    Returns:
    
    value or null for none
  - setDataScope
```
public Query setDataScope(String dataScope)
```
    The data source to search.
    
    Parameters:
    
    dataScope - dataScope or null for none
  - getDriveDocumentInfo
```
public DriveDocumentInfo getDriveDocumentInfo()
```
    Required when **SearchMethod** is **DRIVE_DOCUMENT**.
    
    Returns:
    
    value or null for none
  - setDriveDocumentInfo
```
public Query setDriveDocumentInfo(DriveDocumentInfo driveDocumentInfo)
```
    Required when **SearchMethod** is **DRIVE_DOCUMENT**.
    
    Parameters:
    
    driveDocumentInfo - driveDocumentInfo or null for none
  - getDriveOptions
```
public DriveOptions getDriveOptions()
```
    Set Drive search-specific options.
    
    Returns:
    
    value or null for none
  - setDriveOptions
```
public Query setDriveOptions(DriveOptions driveOptions)
```
    Set Drive search-specific options.
    
    Parameters:
    
    driveOptions - driveOptions or null for none
  - getEndTime
```
public String getEndTime()
```
    The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    
    Returns:
    
    value or null for none
  - setEndTime
```
public Query setEndTime(String endTime)
```
    The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    
    Parameters:
    
    endTime - endTime or null for none
  - getGeminiOptions
```
public GeminiOptions getGeminiOptions()
```
    Set Gemini search-specific options.
    
    Returns:
    
    value or null for none
  - setGeminiOptions
```
public Query setGeminiOptions(GeminiOptions geminiOptions)
```
    Set Gemini search-specific options.
    
    Parameters:
    
    geminiOptions - geminiOptions or null for none
  - getHangoutsChatInfo
```
public HangoutsChatInfo getHangoutsChatInfo()
```
    Required when **SearchMethod** is **ROOM**. (read-only)
    
    Returns:
    
    value or null for none
  - setHangoutsChatInfo
```
public Query setHangoutsChatInfo(HangoutsChatInfo hangoutsChatInfo)
```
    Required when **SearchMethod** is **ROOM**. (read-only)
    
    Parameters:
    
    hangoutsChatInfo - hangoutsChatInfo or null for none
  - getHangoutsChatOptions
```
public HangoutsChatOptions getHangoutsChatOptions()
```
    Set Chat search-specific options. (read-only)
    
    Returns:
    
    value or null for none
  - setHangoutsChatOptions
```
public Query setHangoutsChatOptions(HangoutsChatOptions hangoutsChatOptions)
```
    Set Chat search-specific options. (read-only)
    
    Parameters:
    
    hangoutsChatOptions - hangoutsChatOptions or null for none
  - getMailOptions
```
public MailOptions getMailOptions()
```
    Set Gmail search-specific options.
    
    Returns:
    
    value or null for none
  - setMailOptions
```
public Query setMailOptions(MailOptions mailOptions)
```
    Set Gmail search-specific options.
    
    Parameters:
    
    mailOptions - mailOptions or null for none
  - getMethod
```
public String getMethod()
```
    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**.
    
    Returns:
    
    value or null for none
  - setMethod
```
public Query setMethod(String method)
```
    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**.
    
    Parameters:
    
    method - method or null for none
  - getOrgUnitInfo
```
public OrgUnitInfo getOrgUnitInfo()
```
    Required when **SearchMethod** is **ORG_UNIT**.
    
    Returns:
    
    value or null for none
  - setOrgUnitInfo
```
public Query setOrgUnitInfo(OrgUnitInfo orgUnitInfo)
```
    Required when **SearchMethod** is **ORG_UNIT**.
    
    Parameters:
    
    orgUnitInfo - orgUnitInfo or null for none
  - getSearchMethod
```
public String getSearchMethod()
```
    The search method to use.
    
    Returns:
    
    value or null for none
  - setSearchMethod
```
public Query setSearchMethod(String searchMethod)
```
    The search method to use.
    
    Parameters:
    
    searchMethod - searchMethod or null for none
  - getSharedDriveInfo
```
public SharedDriveInfo getSharedDriveInfo()
```
    Required when **SearchMethod** is **SHARED_DRIVE**.
    
    Returns:
    
    value or null for none
  - setSharedDriveInfo
```
public Query setSharedDriveInfo(SharedDriveInfo sharedDriveInfo)
```
    Required when **SearchMethod** is **SHARED_DRIVE**.
    
    Parameters:
    
    sharedDriveInfo - sharedDriveInfo or null for none
  - getSitesUrlInfo
```
public SitesUrlInfo getSitesUrlInfo()
```
    Required when **SearchMethod** is **SITES_URL**.
    
    Returns:
    
    value or null for none
  - setSitesUrlInfo
```
public Query setSitesUrlInfo(SitesUrlInfo sitesUrlInfo)
```
    Required when **SearchMethod** is **SITES_URL**.
    
    Parameters:
    
    sitesUrlInfo - sitesUrlInfo or null for none
  - getStartTime
```
public String getStartTime()
```
    The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    
    Returns:
    
    value or null for none
  - setStartTime
```
public Query setStartTime(String startTime)
```
    The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
    
    Parameters:
    
    startTime - startTime or null for none
  - getTeamDriveInfo
```
public TeamDriveInfo getTeamDriveInfo()
```
    Required when **SearchMethod** is **TEAM_DRIVE**.
    
    Returns:
    
    value or null for none
  - setTeamDriveInfo
```
public Query setTeamDriveInfo(TeamDriveInfo teamDriveInfo)
```
    Required when **SearchMethod** is **TEAM_DRIVE**.
    
    Parameters:
    
    teamDriveInfo - teamDriveInfo or null for none
  - getTerms
```
public String getTerms()
```
    Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
    
    Returns:
    
    value or null for none
  - setTerms
```
public Query setTerms(String terms)
```
    Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
    
    Parameters:
    
    terms - terms or null for none
  - getTimeZone
```
public String getTimeZone()
```
    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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
    
    Returns:
    
    value or null for none
  - setTimeZone
```
public Query setTimeZone(String timeZone)
```
    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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
    
    Parameters:
    
    timeZone - timeZone or null for none
  - getVoiceOptions
```
public VoiceOptions getVoiceOptions()
```
    Set Voice search-specific options.
    
    Returns:
    
    value or null for none
  - setVoiceOptions
```
public Query setVoiceOptions(VoiceOptions voiceOptions)
```
    Set Voice search-specific options.
    
    Parameters:
    
    voiceOptions - voiceOptions or null for none
  - set
```
public Query set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Query clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Query

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Query

Method Detail

getAccountInfo

setAccountInfo

getCalendarOptions

setCalendarOptions

getCorpus

setCorpus

getDataScope

setDataScope

getDriveDocumentInfo

setDriveDocumentInfo

getDriveOptions

setDriveOptions

getEndTime

setEndTime

getGeminiOptions

setGeminiOptions

getHangoutsChatInfo

setHangoutsChatInfo

getHangoutsChatOptions

setHangoutsChatOptions

getMailOptions

setMailOptions

getMethod

setMethod

getOrgUnitInfo

setOrgUnitInfo

getSearchMethod

setSearchMethod

getSharedDriveInfo

setSharedDriveInfo

getSitesUrlInfo

setSitesUrlInfo

getStartTime

setStartTime

getTeamDriveInfo

setTeamDriveInfo

getTerms

setTerms

getTimeZone

setTimeZone

getVoiceOptions

setVoiceOptions

set

clone