Class: Google::Apis::VaultV1::Query

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/vault_v1/classes.rb,
lib/google/apis/vault_v1/representations.rb,
lib/google/apis/vault_v1/representations.rb

Overview

The query definition used for search and export.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



1587
1588
1589
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1587

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_info ⇒ Google::Apis::VaultV1::AccountInfo

The accounts to search Corresponds to the JSON property accountInfo

Returns:



1496
1497
1498
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1496

def 
  @account_info
end

#corpus ⇒ String

The Google Workspace service to search. Corresponds to the JSON property corpus

Returns:

  • (String) 


1501
1502
1503
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1501

def corpus
  @corpus
end

#data_scope ⇒ String

The data source to search. Corresponds to the JSON property dataScope

Returns:

  • (String) 


1506
1507
1508
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1506

def data_scope
  @data_scope
end

#drive_options ⇒ Google::Apis::VaultV1::DriveOptions

Additional options for Drive search Corresponds to the JSON property driveOptions

Returns:



1511
1512
1513
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1511

def drive_options
  @drive_options
end

#end_time ⇒ String

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

Returns:

  • (String) 


1517
1518
1519
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1517

def end_time
  @end_time
end

#hangouts_chat_info ⇒ Google::Apis::VaultV1::HangoutsChatInfo

The Chat spaces to search Corresponds to the JSON property hangoutsChatInfo

Returns:



1522
1523
1524
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1522

def hangouts_chat_info
  @hangouts_chat_info
end

#hangouts_chat_options ⇒ Google::Apis::VaultV1::HangoutsChatOptions

Additional options for Google Chat search Corresponds to the JSON property hangoutsChatOptions

Returns:



1527
1528
1529
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1527

def hangouts_chat_options
  @hangouts_chat_options
end

#mail_options ⇒ Google::Apis::VaultV1::MailOptions

Additional options for Gmail search Corresponds to the JSON property mailOptions

Returns:



1532
1533
1534
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1532

def mail_options
  @mail_options
end

#method_prop ⇒ String

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. Corresponds to the JSON property method

Returns:

  • (String) 


1539
1540
1541
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1539

def method_prop
  @method_prop
end

#org_unit_info ⇒ Google::Apis::VaultV1::OrgUnitInfo

The organizational unit to search Corresponds to the JSON property orgUnitInfo

Returns:



1544
1545
1546
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1544

def org_unit_info
  @org_unit_info
end

#search_method ⇒ String

The search method to use. Corresponds to the JSON property searchMethod

Returns:

  • (String) 


1549
1550
1551
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1549

def search_method
  @search_method
end

#shared_drive_info ⇒ Google::Apis::VaultV1::SharedDriveInfo

The shared drives to search Corresponds to the JSON property sharedDriveInfo

Returns:



1554
1555
1556
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1554

def shared_drive_info
  @shared_drive_info
end

#start_time ⇒ String

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

Returns:

  • (String) 


1560
1561
1562
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1560

def start_time
  @start_time
end

#team_drive_info ⇒ Google::Apis::VaultV1::TeamDriveInfo

Team Drives to search Corresponds to the JSON property teamDriveInfo

Returns:



1565
1566
1567
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1565

def team_drive_info
  @team_drive_info
end

#terms ⇒ String

Service-specific search operators to filter search results. Corresponds to the JSON property terms

Returns:

  • (String) 


1571
1572
1573
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1571

def terms
  @terms
end

#time_zone ⇒ String

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. Corresponds to the JSON property timeZone

Returns:

  • (String) 


1580
1581
1582
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1580

def time_zone
  @time_zone
end

#voice_options ⇒ Google::Apis::VaultV1::VoiceOptions

Additional options for Voice search Corresponds to the JSON property voiceOptions

Returns:



1585
1586
1587
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1585

def voice_options
  @voice_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1592

def update!(**args)
  @account_info = args[:account_info] if args.key?(:account_info)
  @corpus = args[:corpus] if args.key?(:corpus)
  @data_scope = args[:data_scope] if args.key?(:data_scope)
  @drive_options = args[:drive_options] if args.key?(:drive_options)
  @end_time = args[:end_time] if args.key?(:end_time)
  @hangouts_chat_info = args[:hangouts_chat_info] if args.key?(:hangouts_chat_info)
  @hangouts_chat_options = args[:hangouts_chat_options] if args.key?(:hangouts_chat_options)
  @mail_options = args[:mail_options] if args.key?(:mail_options)
  @method_prop = args[:method_prop] if args.key?(:method_prop)
  @org_unit_info = args[:org_unit_info] if args.key?(:org_unit_info)
  @search_method = args[:search_method] if args.key?(:search_method)
  @shared_drive_info = args[:shared_drive_info] if args.key?(:shared_drive_info)
  @start_time = args[:start_time] if args.key?(:start_time)
  @team_drive_info = args[:team_drive_info] if args.key?(:team_drive_info)
  @terms = args[:terms] if args.key?(:terms)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @voice_options = args[:voice_options] if args.key?(:voice_options)
end