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

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

Overview

A description of the execution of a transfer.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TransferOperation

Returns a new instance of TransferOperation.



1696
1697
1698
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1696

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:



1634
1635
1636
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1634

def counters
  @counters
end

#end_time ⇒ String

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

Returns:

  • (String) 


1639
1640
1641
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1639

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:



1644
1645
1646
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1644

def error_breakdowns
  @error_breakdowns
end

#logging_config ⇒ Google::Apis::StoragetransferV1::LoggingConfig

Specifies the logging behavior for transfer operations. Logs can be sent to Cloud Logging for all transfer types. See Read transfer logs for details. Corresponds to the JSON property loggingConfig

Returns:



1651
1652
1653
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1651

def logging_config
  @logging_config
end

#name ⇒ String

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

Returns:

  • (String) 


1656
1657
1658
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1656

def name
  @name
end

#notification_config ⇒ Google::Apis::StoragetransferV1::NotificationConfig

Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes: * "eventType": one of the EventType values * " payloadFormat": one of the PayloadFormat values * "projectId": the project_id of the TransferOperation * "transferJobName": the transfer_job_name of the TransferOperation * "transferOperationName": the name of the TransferOperation The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat . Corresponds to the JSON property notificationConfig

Returns:



1669
1670
1671
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1669

def notification_config
  @notification_config
end

#project_id ⇒ String

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

Returns:

  • (String) 


1674
1675
1676
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1674

def project_id
  @project_id
end

#start_time ⇒ String

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

Returns:

  • (String) 


1679
1680
1681
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1679

def start_time
  @start_time
end

#status ⇒ String

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

Returns:

  • (String) 


1684
1685
1686
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1684

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) 


1689
1690
1691
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1689

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:



1694
1695
1696
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1694

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1701

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)
  @logging_config = args[:logging_config] if args.key?(:logging_config)
  @name = args[:name] if args.key?(:name)
  @notification_config = args[:notification_config] if args.key?(:notification_config)
  @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