Class: Google::Cloud::StorageTransfer::V1::TransferOperation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

A description of the execution of a transfer.

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Attribute Details

#counters ⇒ ::Google::Cloud::StorageTransfer::V1::TransferCounters

Returns Information about the progress of the transfer operation.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns End time of this transfer execution.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#error_breakdowns ⇒ ::Array<::Google::Cloud::StorageTransfer::V1::ErrorSummary>

Returns Summarizes errors encountered with sample error log entries.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#logging_config ⇒ ::Google::Cloud::StorageTransfer::V1::LoggingConfig

Returns Cloud Logging configuration.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#name ⇒ ::String

Returns A globally unique ID assigned by the system.

Returns:

  • (::String) —

    A globally unique ID assigned by the system.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#notification_config ⇒ ::Google::Cloud::StorageTransfer::V1::NotificationConfig

Returns Notification configuration.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#project_id ⇒ ::String

Returns The ID of the Google Cloud project that owns the operation.

Returns:

  • (::String) —

    The ID of the Google Cloud project that owns the operation.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Start time of this transfer execution.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#status ⇒ ::Google::Cloud::StorageTransfer::V1::TransferOperation::Status

Returns Status of the transfer operation.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#transfer_job_name ⇒ ::String

Returns The name of the transfer job that triggers this transfer operation.

Returns:

  • (::String) —

    The name of the transfer job that triggers this transfer operation.



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end

#transfer_spec ⇒ ::Google::Cloud::StorageTransfer::V1::TransferSpec

Returns Transfer specification.

Returns:



1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 1500

class TransferOperation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a TransferOperation.
  module Status
    # Zero is an illegal value.
    STATUS_UNSPECIFIED = 0

    # In progress.
    IN_PROGRESS = 1

    # Paused.
    PAUSED = 2

    # Completed successfully.
    SUCCESS = 3

    # Terminated due to an unrecoverable failure.
    FAILED = 4

    # Aborted by the user.
    ABORTED = 5

    # Temporarily delayed by the system. No user action is required.
    QUEUED = 6

    # The operation is suspending and draining the ongoing work to completion.
    SUSPENDING = 7
  end
end