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



813
814
815
 
# File 'generated/google/apis/vault_v1/classes.rb', line 813

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:



780
781
782
 
# File 'generated/google/apis/vault_v1/classes.rb', line 780

def accounts
  @accounts
end

#corpus ⇒ String

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

Returns:

  • (String) 


785
786
787
 
# File 'generated/google/apis/vault_v1/classes.rb', line 785

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) 


790
791
792
 
# File 'generated/google/apis/vault_v1/classes.rb', line 790

def hold_id
  @hold_id
end

#name ⇒ String

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

Returns:

  • (String) 


795
796
797
 
# File 'generated/google/apis/vault_v1/classes.rb', line 795

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:



801
802
803
 
# File 'generated/google/apis/vault_v1/classes.rb', line 801

def org_unit
  @org_unit
end

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

Corpus specific queries. Corresponds to the JSON property query

Returns:



806
807
808
 
# File 'generated/google/apis/vault_v1/classes.rb', line 806

def query
  @query
end

#update_time ⇒ String

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

Returns:

  • (String) 


811
812
813
 
# File 'generated/google/apis/vault_v1/classes.rb', line 811

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



818
819
820
821
822
823
824
825
826
 
# File 'generated/google/apis/vault_v1/classes.rb', line 818

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