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.



1623
1624
1625
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1623

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:



1557
1558
1559
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1557

def counters
  @counters
end

#end_time ⇒ String

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

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1562

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:



1567
1568
1569
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1567

def error_breakdowns
  @error_breakdowns
end

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

Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See Read transfer logs for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See Managing Transfer for on-premises jobs for details. Corresponds to the JSON property loggingConfig

Returns:



1578
1579
1580
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1578

def logging_config
  @logging_config
end

#name ⇒ String

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

Returns:

  • (String) 


1583
1584
1585
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1583

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:



1596
1597
1598
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1596

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) 


1601
1602
1603
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1601

def project_id
  @project_id
end

#start_time ⇒ String

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

Returns:

  • (String) 


1606
1607
1608
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1606

def start_time
  @start_time
end

#status ⇒ String

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

Returns:

  • (String) 


1611
1612
1613
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1611

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) 


1616
1617
1618
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1616

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:



1621
1622
1623
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1621

def transfer_spec
  @transfer_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
 
# File 'lib/google/apis/storagetransfer_v1/classes.rb', line 1628

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