Class: Google::Apis::VaultV1::SavedQuery

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 definition of a saved query. To work with Vault resources, the account must have the required Vault privileges and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the View All Matters privilege.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SavedQuery

Returns a new instance of SavedQuery.



1864
1865
1866
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1864

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

Instance Attribute Details

#create_time ⇒ String

Output only. The server-generated timestamp when the saved query was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1840
1841
1842
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1840

def create_time
  @create_time
end

#display_name ⇒ String

The name of the saved query. Corresponds to the JSON property displayName

Returns:

  • (String) 


1845
1846
1847
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1845

def display_name
  @display_name
end

#matter_id ⇒ String

Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL. Corresponds to the JSON property matterId

Returns:

  • (String) 


1852
1853
1854
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1852

def matter_id
  @matter_id
end

#query ⇒ Google::Apis::VaultV1::Query

The query definition used for search and export. Corresponds to the JSON property query

Returns:



1857
1858
1859
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1857

def query
  @query
end

#saved_query_id ⇒ String

A unique identifier for the saved query. Corresponds to the JSON property savedQueryId

Returns:

  • (String) 


1862
1863
1864
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1862

def saved_query_id
  @saved_query_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1869
1870
1871
1872
1873
1874
1875
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1869

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @matter_id = args[:matter_id] if args.key?(:matter_id)
  @query = args[:query] if args.key?(:query)
  @saved_query_id = args[:saved_query_id] if args.key?(:saved_query_id)
end