Class: Google::Apis::VaultV1::Hold

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

Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.

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) ⇒ Hold

Returns a new instance of Hold



330
331
332
 
# File 'generated/google/apis/vault_v1/classes.rb', line 330

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

Instance Attribute Details

#accounts ⇒ Array<Google::Apis::VaultV1::HeldAccount>

If set, the hold applies to the enumerated accounts and org_unit must be empty. Corresponds to the JSON property accounts

Returns:



297
298
299
 
# File 'generated/google/apis/vault_v1/classes.rb', line 297

def accounts
  @accounts
end

#corpus ⇒ String

The corpus to be searched. Corresponds to the JSON property corpus

Returns:

  • (String) 


302
303
304
 
# File 'generated/google/apis/vault_v1/classes.rb', line 302

def corpus
  @corpus
end

#hold_id ⇒ String

The unique immutable ID of the hold. Assigned during creation. Corresponds to the JSON property holdId

Returns:

  • (String) 


307
308
309
 
# File 'generated/google/apis/vault_v1/classes.rb', line 307

def hold_id
  @hold_id
end

#name ⇒ String

The name of the hold. Corresponds to the JSON property name

Returns:

  • (String) 


312
313
314
 
# File 'generated/google/apis/vault_v1/classes.rb', line 312

def name
  @name
end

#org_unit ⇒ Google::Apis::VaultV1::HeldOrgUnit

A organizational unit being held in a particular hold. This structure is immutable. Corresponds to the JSON property orgUnit

Returns:



318
319
320
 
# File 'generated/google/apis/vault_v1/classes.rb', line 318

def org_unit
  @org_unit
end

#query ⇒ Google::Apis::VaultV1::CorpusQuery

Corpus specific queries. Corresponds to the JSON property query

Returns:



323
324
325
 
# File 'generated/google/apis/vault_v1/classes.rb', line 323

def query
  @query
end

#update_time ⇒ String

The last time this hold was modified. Corresponds to the JSON property updateTime

Returns:

  • (String) 


328
329
330
 
# File 'generated/google/apis/vault_v1/classes.rb', line 328

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



335
336
337
338
339
340
341
342
343
 
# File 'generated/google/apis/vault_v1/classes.rb', line 335

def update!(**args)
  @accounts = args[:accounts] if args.key?(:accounts)
  @corpus = args[:corpus] if args.key?(:corpus)
  @hold_id = args[:hold_id] if args.key?(:hold_id)
  @name = args[:name] if args.key?(:name)
  @org_unit = args[:org_unit] if args.key?(:org_unit)
  @query = args[:query] if args.key?(:query)
  @update_time = args[:update_time] if args.key?(:update_time)
end