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.



1889
1890
1891
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1889

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) 


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

def create_time
  @create_time
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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) 


1877
1878
1879
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1877

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:



1882
1883
1884
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1882

def query
  @query
end

#saved_query_id ⇒ String

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

Returns:

  • (String) 


1887
1888
1889
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1887

def saved_query_id
  @saved_query_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1894
1895
1896
1897
1898
1899
1900
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1894

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