GoogleApi.Vault.V1.Model.Query (google_api_vault v0.25.0)

View Source

The query definition used for search and export.

Attributes

  • accountInfo (type: GoogleApi.Vault.V1.Model.AccountInfo.t, default: nil) - Required when SearchMethod is ACCOUNT.
  • calendarOptions (type: GoogleApi.Vault.V1.Model.CalendarOptions.t, default: nil) - Set Calendar search-specific options.
  • corpus (type: String.t, default: nil) - The Google Workspace service to search.
  • dataScope (type: String.t, default: nil) - The data source to search.
  • driveDocumentInfo (type: GoogleApi.Vault.V1.Model.DriveDocumentInfo.t, default: nil) - Required when SearchMethod is DRIVE_DOCUMENT.
  • driveOptions (type: GoogleApi.Vault.V1.Model.DriveOptions.t, default: nil) - Set Drive search-specific options.
  • endTime (type: DateTime.t, default: nil) - The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
  • geminiOptions (type: GoogleApi.Vault.V1.Model.GeminiOptions.t, default: nil) - Set Gemini search-specific options.
  • hangoutsChatInfo (type: GoogleApi.Vault.V1.Model.HangoutsChatInfo.t, default: nil) - Required when SearchMethod is ROOM. (read-only)
  • hangoutsChatOptions (type: GoogleApi.Vault.V1.Model.HangoutsChatOptions.t, default: nil) - Set Chat search-specific options. (read-only)
  • mailOptions (type: GoogleApi.Vault.V1.Model.MailOptions.t, default: nil) - Set Gmail search-specific options.
  • method (type: String.t, default: nil) - 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 (type: GoogleApi.Vault.V1.Model.OrgUnitInfo.t, default: nil) - Required when SearchMethod is ORG_UNIT.
  • searchMethod (type: String.t, default: nil) - The search method to use.
  • sharedDriveInfo (type: GoogleApi.Vault.V1.Model.SharedDriveInfo.t, default: nil) - Required when SearchMethod is SHARED_DRIVE.
  • sitesUrlInfo (type: GoogleApi.Vault.V1.Model.SitesUrlInfo.t, default: nil) - Required when SearchMethod is SITES_URL.
  • startTime (type: DateTime.t, default: nil) - The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
  • teamDriveInfo (type: GoogleApi.Vault.V1.Model.TeamDriveInfo.t, default: nil) - Required when SearchMethod is TEAM_DRIVE.
  • terms (type: String.t, default: nil) - Service-specific search operators to filter search results.
  • timeZone (type: String.t, default: nil) - 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 (type: GoogleApi.Vault.V1.Model.VoiceOptions.t, default: nil) - Set Voice search-specific options.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Vault.V1.Model.Query{
  accountInfo: GoogleApi.Vault.V1.Model.AccountInfo.t() | nil,
  calendarOptions: GoogleApi.Vault.V1.Model.CalendarOptions.t() | nil,
  corpus: String.t() | nil,
  dataScope: String.t() | nil,
  driveDocumentInfo: GoogleApi.Vault.V1.Model.DriveDocumentInfo.t() | nil,
  driveOptions: GoogleApi.Vault.V1.Model.DriveOptions.t() | nil,
  endTime: DateTime.t() | nil,
  geminiOptions: GoogleApi.Vault.V1.Model.GeminiOptions.t() | nil,
  hangoutsChatInfo: GoogleApi.Vault.V1.Model.HangoutsChatInfo.t() | nil,
  hangoutsChatOptions: GoogleApi.Vault.V1.Model.HangoutsChatOptions.t() | nil,
  mailOptions: GoogleApi.Vault.V1.Model.MailOptions.t() | nil,
  method: String.t() | nil,
  orgUnitInfo: GoogleApi.Vault.V1.Model.OrgUnitInfo.t() | nil,
  searchMethod: String.t() | nil,
  sharedDriveInfo: GoogleApi.Vault.V1.Model.SharedDriveInfo.t() | nil,
  sitesUrlInfo: GoogleApi.Vault.V1.Model.SitesUrlInfo.t() | nil,
  startTime: DateTime.t() | nil,
  teamDriveInfo: GoogleApi.Vault.V1.Model.TeamDriveInfo.t() | nil,
  terms: String.t() | nil,
  timeZone: String.t() | nil,
  voiceOptions: GoogleApi.Vault.V1.Model.VoiceOptions.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.