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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



1191
1192
1193
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1191

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:



1103
1104
1105
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1103

def 
  @account_info
end

#corpus ⇒ String

The corpus to search. Corresponds to the JSON property corpus

Returns:

  • (String) 


1108
1109
1110
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1108

def corpus
  @corpus
end

#data_scope ⇒ String

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

Returns:

  • (String) 


1113
1114
1115
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1113

def data_scope
  @data_scope
end

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

Drive search advanced options Corresponds to the JSON property driveOptions

Returns:



1118
1119
1120
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1118

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) 


1124
1125
1126
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1124

def end_time
  @end_time
end

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

Accounts to search Corresponds to the JSON property hangoutsChatInfo

Returns:



1129
1130
1131
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1129

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:



1134
1135
1136
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1134

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:



1139
1140
1141
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1139

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) 


1147
1148
1149
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1147

def method_prop
  @method_prop
end

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

Org Unit to search Corresponds to the JSON property orgUnitInfo

Returns:



1152
1153
1154
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1152

def org_unit_info
  @org_unit_info
end

#search_method ⇒ String

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

Returns:

  • (String) 


1157
1158
1159
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1157

def search_method
  @search_method
end

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

Shared drives to search Corresponds to the JSON property sharedDriveInfo

Returns:



1162
1163
1164
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1162

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) 


1168
1169
1170
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1168

def start_time
  @start_time
end

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

Team Drives to search Corresponds to the JSON property teamDriveInfo

Returns:



1173
1174
1175
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1173

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) 


1180
1181
1182
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1180

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) 


1189
1190
1191
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1189

def time_zone
  @time_zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1196

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)
end