Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::TransferOperation.
A description of the execution of a transfer.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#counters
def counters() -> ::Google::Cloud::StorageTransfer::V1::TransferCounters
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferCounters) — Information about the progress of the transfer operation.
#counters=
def counters=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferCounters
Parameter
- value (::Google::Cloud::StorageTransfer::V1::TransferCounters) — Information about the progress of the transfer operation.
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferCounters) — Information about the progress of the transfer operation.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — End time of this transfer execution.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — End time of this transfer execution.
Returns
- (::Google::Protobuf::Timestamp) — End time of this transfer execution.
#error_breakdowns
def error_breakdowns() -> ::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>
Returns
- (::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>) — Summarizes errors encountered with sample error log entries.
#error_breakdowns=
def error_breakdowns=(value) -> ::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>
Parameter
- value (::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>) — Summarizes errors encountered with sample error log entries.
Returns
- (::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>) — Summarizes errors encountered with sample error log entries.
#logging_config
def logging_config() -> ::Google::Cloud::StorageTransfer::V1::LoggingConfig
Returns
- (::Google::Cloud::StorageTransfer::V1::LoggingConfig) — Cloud Logging configuration.
#logging_config=
def logging_config=(value) -> ::Google::Cloud::StorageTransfer::V1::LoggingConfig
Parameter
- value (::Google::Cloud::StorageTransfer::V1::LoggingConfig) — Cloud Logging configuration.
Returns
- (::Google::Cloud::StorageTransfer::V1::LoggingConfig) — Cloud Logging configuration.
#name
def name() -> ::String
Returns
- (::String) — A globally unique ID assigned by the system.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — A globally unique ID assigned by the system.
Returns
- (::String) — A globally unique ID assigned by the system.
#notification_config
def notification_config() -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig
Returns
- (::Google::Cloud::StorageTransfer::V1::NotificationConfig) — Notification configuration.
#notification_config=
def notification_config=(value) -> ::Google::Cloud::StorageTransfer::V1::NotificationConfig
Parameter
- value (::Google::Cloud::StorageTransfer::V1::NotificationConfig) — Notification configuration.
Returns
- (::Google::Cloud::StorageTransfer::V1::NotificationConfig) — Notification configuration.
#project_id
def project_id() -> ::String
Returns
- (::String) — The ID of the Google Cloud project that owns the operation.
#project_id=
def project_id=(value) -> ::String
Parameter
- value (::String) — The ID of the Google Cloud project that owns the operation.
Returns
- (::String) — The ID of the Google Cloud project that owns the operation.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Start time of this transfer execution.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — Start time of this transfer execution.
Returns
- (::Google::Protobuf::Timestamp) — Start time of this transfer execution.
#status
def status() -> ::Google::Cloud::StorageTransfer::V1::TransferOperation::Status
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferOperation::Status) — Status of the transfer operation.
#status=
def status=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferOperation::Status
Parameter
- value (::Google::Cloud::StorageTransfer::V1::TransferOperation::Status) — Status of the transfer operation.
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferOperation::Status) — Status of the transfer operation.
#transfer_job_name
def transfer_job_name() -> ::String
Returns
- (::String) — The name of the transfer job that triggers this transfer operation.
#transfer_job_name=
def transfer_job_name=(value) -> ::String
Parameter
- value (::String) — The name of the transfer job that triggers this transfer operation.
Returns
- (::String) — The name of the transfer job that triggers this transfer operation.
#transfer_spec
def transfer_spec() -> ::Google::Cloud::StorageTransfer::V1::TransferSpec
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferSpec) — Transfer specification.
#transfer_spec=
def transfer_spec=(value) -> ::Google::Cloud::StorageTransfer::V1::TransferSpec
Parameter
- value (::Google::Cloud::StorageTransfer::V1::TransferSpec) — Transfer specification.
Returns
- (::Google::Cloud::StorageTransfer::V1::TransferSpec) — Transfer specification.