Class: Google::Apis::VaultV1::Export

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

An export. 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) ⇒ Export

Returns a new instance of Export.



678
679
680
 
# File 'lib/google/apis/vault_v1/classes.rb', line 678

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

Instance Attribute Details

#cloud_storage_sink ⇒ Google::Apis::VaultV1::CloudStorageSink

Export sink for Cloud Storage files. Corresponds to the JSON property cloudStorageSink

Returns:



624
625
626
 
# File 'lib/google/apis/vault_v1/classes.rb', line 624

def cloud_storage_sink
  @cloud_storage_sink
end

#create_time ⇒ String

Output only. The time when the export was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


629
630
631
 
# File 'lib/google/apis/vault_v1/classes.rb', line 629

def create_time
  @create_time
end

#export_options ⇒ Google::Apis::VaultV1::ExportOptions

Additional options for exports Corresponds to the JSON property exportOptions

Returns:



634
635
636
 
# File 'lib/google/apis/vault_v1/classes.rb', line 634

def export_options
  @export_options
end

#id ⇒ String

Output only. The generated export ID. Corresponds to the JSON property id

Returns:

  • (String) 


639
640
641
 
# File 'lib/google/apis/vault_v1/classes.rb', line 639

def id
  @id
end

#matter_id ⇒ String

Output only. The matter ID. Corresponds to the JSON property matterId

Returns:

  • (String) 


644
645
646
 
# File 'lib/google/apis/vault_v1/classes.rb', line 644

def matter_id
  @matter_id
end

#name ⇒ String

The export name. Don't use special characters (~!$'(),;@:/?) in the name, they can prevent you from downloading exports. Corresponds to the JSON property name

Returns:

  • (String) 


650
651
652
 
# File 'lib/google/apis/vault_v1/classes.rb', line 650

def name
  @name
end

#parent_export_id ⇒ String

Output only. Identifies the parent export that spawned this child export. This is only set on child exports. Corresponds to the JSON property parentExportId

Returns:

  • (String) 


656
657
658
 
# File 'lib/google/apis/vault_v1/classes.rb', line 656

def parent_export_id
  @parent_export_id
end

#query ⇒ Google::Apis::VaultV1::Query

The query definition used for search and export. Corresponds to the JSON property query

Returns:



661
662
663
 
# File 'lib/google/apis/vault_v1/classes.rb', line 661

def query
  @query
end

#requester ⇒ Google::Apis::VaultV1::UserInfo

User's information. Corresponds to the JSON property requester

Returns:



666
667
668
 
# File 'lib/google/apis/vault_v1/classes.rb', line 666

def requester
  @requester
end

#stats ⇒ Google::Apis::VaultV1::ExportStats

Progress information for an export. Corresponds to the JSON property stats

Returns:



671
672
673
 
# File 'lib/google/apis/vault_v1/classes.rb', line 671

def stats
  @stats
end

#status ⇒ String

Output only. The status of the export. Corresponds to the JSON property status

Returns:

  • (String) 


676
677
678
 
# File 'lib/google/apis/vault_v1/classes.rb', line 676

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/google/apis/vault_v1/classes.rb', line 683

def update!(**args)
  @cloud_storage_sink = args[:cloud_storage_sink] if args.key?(:cloud_storage_sink)
  @create_time = args[:create_time] if args.key?(:create_time)
  @export_options = args[:export_options] if args.key?(:export_options)
  @id = args[:id] if args.key?(:id)
  @matter_id = args[:matter_id] if args.key?(:matter_id)
  @name = args[:name] if args.key?(:name)
  @parent_export_id = args[:parent_export_id] if args.key?(:parent_export_id)
  @query = args[:query] if args.key?(:query)
  @requester = args[:requester] if args.key?(:requester)
  @stats = args[:stats] if args.key?(:stats)
  @status = args[:status] if args.key?(:status)
end