Class: Google::Apis::StoragetransferV1::TransferOperation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/storagetransfer_v1/classes.rb,
generated/google/apis/storagetransfer_v1/representations.rb,
generated/google/apis/storagetransfer_v1/representations.rb

Overview

A description of the execution of a transfer.

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

Returns a new instance of TransferOperation



945
946
947
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 945

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

Instance Attribute Details

#counters ⇒ Google::Apis::StoragetransferV1::TransferCounters

A collection of counters that report the progress of a transfer operation. Corresponds to the JSON property counters

Returns:



902
903
904
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 902

def counters
  @counters
end

#end_time ⇒ String

End time of this transfer execution. Corresponds to the JSON property endTime

Returns:

  • (String) 


907
908
909
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 907

def end_time
  @end_time
end

#error_breakdowns ⇒ Array<Google::Apis::StoragetransferV1::ErrorSummary>

Summarizes errors encountered with sample error log entries. Corresponds to the JSON property errorBreakdowns

Returns:



912
913
914
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 912

def error_breakdowns
  @error_breakdowns
end

#name ⇒ String

A globally unique ID assigned by the system. Corresponds to the JSON property name

Returns:

  • (String) 


917
918
919
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 917

def name
  @name
end

#project_id ⇒ String

The ID of the Google Cloud Platform Console project that owns the operation. Required. Corresponds to the JSON property projectId

Returns:

  • (String) 


923
924
925
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 923

def project_id
  @project_id
end

#start_time ⇒ String

Start time of this transfer execution. Corresponds to the JSON property startTime

Returns:

  • (String) 


928
929
930
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 928

def start_time
  @start_time
end

#status ⇒ String

Status of the transfer operation. Corresponds to the JSON property status

Returns:

  • (String) 


933
934
935
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 933

def status
  @status
end

#transfer_job_name ⇒ String

The name of the transfer job that triggers this transfer operation. Corresponds to the JSON property transferJobName

Returns:

  • (String) 


938
939
940
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 938

def transfer_job_name
  @transfer_job_name
end

#transfer_spec ⇒ Google::Apis::StoragetransferV1::TransferSpec

Configuration for running a transfer. Corresponds to the JSON property transferSpec

Returns:



943
944
945
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 943

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



950
951
952
953
954
955
956
957
958
959
960
 
# File 'generated/google/apis/storagetransfer_v1/classes.rb', line 950

def update!(**args)
  @counters = args[:counters] if args.key?(:counters)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error_breakdowns = args[:error_breakdowns] if args.key?(:error_breakdowns)
  @name = args[:name] if args.key?(:name)
  @project_id = args[:project_id] if args.key?(:project_id)
  @start_time = args[:start_time] if args.key?(:start_time)
  @status = args[:status] if args.key?(:status)
  @transfer_job_name = args[:transfer_job_name] if args.key?(:transfer_job_name)
  @transfer_spec = args[:transfer_spec] if args.key?(:transfer_spec)
end