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

Constructor Details

#initialize(**args) ⇒ Hold

Returns a new instance of Hold.



1044
1045
1046
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1044

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:



1011
1012
1013
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1011

def accounts
  @accounts
end

#corpus ⇒ String

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

Returns:

  • (String) 


1016
1017
1018
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1016

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) 


1021
1022
1023
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1021

def hold_id
  @hold_id
end

#name ⇒ String

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

Returns:

  • (String) 


1026
1027
1028
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1026

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:



1032
1033
1034
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1032

def org_unit
  @org_unit
end

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

Corpus specific queries. Corresponds to the JSON property query

Returns:



1037
1038
1039
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1037

def query
  @query
end

#update_time ⇒ String

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

Returns:

  • (String) 


1042
1043
1044
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1042

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'generated/google/apis/vault_v1/classes.rb', line 1049

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