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

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

Overview

A query definition relevant for search & export.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



1545
1546
1547
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1545

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

Instance Attribute Details

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

Accounts to search Corresponds to the JSON property accountInfo

Returns:



1457
1458
1459
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1457

def 
  @account_info
end

#corpus ⇒ String

The corpus to search. Corresponds to the JSON property corpus

Returns:

  • (String) 


1462
1463
1464
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1462

def corpus
  @corpus
end

#data_scope ⇒ String

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

Returns:

  • (String) 


1467
1468
1469
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1467

def data_scope
  @data_scope
end

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

Drive search advanced options Corresponds to the JSON property driveOptions

Returns:



1472
1473
1474
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1472

def drive_options
  @drive_options
end

#end_time ⇒ String

The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. Corresponds to the JSON property endTime

Returns:

  • (String) 


1478
1479
1480
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1478

def end_time
  @end_time
end

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

Accounts to search Corresponds to the JSON property hangoutsChatInfo

Returns:



1483
1484
1485
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1483

def hangouts_chat_info
  @hangouts_chat_info
end

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

Hangouts chat search advanced options Corresponds to the JSON property hangoutsChatOptions

Returns:



1488
1489
1490
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1488

def hangouts_chat_options
  @hangouts_chat_options
end

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

Mail search advanced options Corresponds to the JSON property mailOptions

Returns:



1493
1494
1495
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1493

def mail_options
  @mail_options
end

#method_prop ⇒ String

The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only. Corresponds to the JSON property method

Returns:

  • (String) 


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

def method_prop
  @method_prop
end

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

Org Unit to search Corresponds to the JSON property orgUnitInfo

Returns:



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

def org_unit_info
  @org_unit_info
end

#search_method ⇒ String

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

Returns:

  • (String) 


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

def search_method
  @search_method
end

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

Shared drives to search Corresponds to the JSON property sharedDriveInfo

Returns:



1516
1517
1518
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1516

def shared_drive_info
  @shared_drive_info
end

#start_time ⇒ String

The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date. Corresponds to the JSON property startTime

Returns:

  • (String) 


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

def start_time
  @start_time
end

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

Team Drives to search Corresponds to the JSON property teamDriveInfo

Returns:



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

def team_drive_info
  @team_drive_info
end

#terms ⇒ String

The corpus-specific search operators used to generate search results. Corresponds to the JSON property terms

Returns:

  • (String) 


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

def terms
  @terms
end

#time_zone ⇒ String

The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles" . For more information, see Time Zone. Corresponds to the JSON property timeZone

Returns:

  • (String) 


1538
1539
1540
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1538

def time_zone
  @time_zone
end

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

Voice search options Corresponds to the JSON property voiceOptions

Returns:



1543
1544
1545
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1543

def voice_options
  @voice_options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1550

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