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

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

A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. 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) ⇒ Hold

Returns a new instance of Hold.



1078
1079
1080
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1078

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

Instance Attribute Details

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

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

Returns:



1046
1047
1048
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1046

def accounts
  @accounts
end

#corpus ⇒ String

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

Returns:

  • (String) 


1051
1052
1053
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1051

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) 


1056
1057
1058
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1056

def hold_id
  @hold_id
end

#name ⇒ String

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

Returns:

  • (String) 


1061
1062
1063
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1061

def name
  @name
end

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

The organizational unit covered by a hold. This structure is immutable. Corresponds to the JSON property orgUnit

Returns:



1066
1067
1068
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1066

def org_unit
  @org_unit
end

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

Service-specific options for holds. Corresponds to the JSON property query

Returns:



1071
1072
1073
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1071

def query
  @query
end

#update_time ⇒ String

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

Returns:

  • (String) 


1076
1077
1078
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1076

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1083
1084
1085
1086
1087
1088
1089
1090
1091
 
# File 'lib/google/apis/vault_v1/classes.rb', line 1083

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