Class: Com::Vmware::Appliance::Recovery::Backup::Job::BackupJobStatus

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb

Overview

``Com::Vmware::Appliance::Recovery::Backup::Job::BackupJobStatus`` class Structure representing backup restore status

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (BackupJobStatus) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



362
363
364
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 362

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (DateTime?) end_time

Time when this backup was finished. endTime End time is None till backup is finished.

Returns:

  • (DateTime, nil) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String) id

TimeStamp based ID

Returns:

  • (String) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Array<Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage>) messages

list of messages

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Fixnum) progress

percentage complete

Returns:

  • (Fixnum) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (DateTime) start_time

Time when this backup was started.

Returns:

  • (DateTime) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState) state

process state

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 329

class BackupJobStatus < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.appliance.recovery.backup.job.backup_job_status',
                {
                    'id' => VAPI::Bindings::StringType.instance,
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
                    'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
                    'progress' => VAPI::Bindings::IntegerType.instance,
                    'start_time' => VAPI::Bindings::DateTimeType.instance,
                    'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                },
                BackupJobStatus,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :state,
                  :messages,
                  :progress,
                  :start_time,
                  :end_time

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 335

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.recovery.backup.job.backup_job_status',
        {
            'id' => VAPI::Bindings::StringType.instance,
            'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::BackupRestoreProcessState'),
            'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::LocalizableMessage')),
            'progress' => VAPI::Bindings::IntegerType.instance,
            'start_time' => VAPI::Bindings::DateTimeType.instance,
            'end_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
        },
        BackupJobStatus,
        false,
        nil)
end