Class List Method List File List

# Class: Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb

## Overview

``Com::Vmware::Appliance::Recovery::Restore::Job::RestoreJobStatus`` class Structure representing backup restore status

## Instance Attribute Summary (collapse)

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

  list of messages.

- - (Fixnum) progress

  percentage complete.

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

  process state.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

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

## Instance Method Summary (collapse)

- - (RestoreJobStatus) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`RestoreJobStatus`) 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)

    298
    299
    300
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 298

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

## Instance Attribute Details

### - (`Array<Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage>`) messages

list of messages

Returns:

- (`Array<Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage>`)

    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 271

    class RestoreJobStatus < 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.restore.job.restore_job_status',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::BackupRestoreProcessState'),
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage')),
                        'progress' => VAPI::Bindings::IntegerType.instance,
                    },
                    RestoreJobStatus,
                    false,
                    nil)
            end
        end

        attr_accessor :state,
                      :messages,
                      :progress

        # 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`)

    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 271

    class RestoreJobStatus < 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.restore.job.restore_job_status',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::BackupRestoreProcessState'),
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage')),
                        'progress' => VAPI::Bindings::IntegerType.instance,
                    },
                    RestoreJobStatus,
                    false,
                    nil)
            end
        end

        attr_accessor :state,
                      :messages,
                      :progress

        # 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::Restore::Job::BackupRestoreProcessState`) state

process state

Returns:

- (`Com::Vmware::Appliance::Recovery::Restore::Job::BackupRestoreProcessState`)

    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 271

    class RestoreJobStatus < 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.restore.job.restore_job_status',
                    {
                        'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::BackupRestoreProcessState'),
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage')),
                        'progress' => VAPI::Bindings::IntegerType.instance,
                    },
                    RestoreJobStatus,
                    false,
                    nil)
            end
        end

        attr_accessor :state,
                      :messages,
                      :progress

        # 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

    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/restore.rb', line 277

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.recovery.restore.job.restore_job_status',
            {
                'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::BackupRestoreProcessState'),
                'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::Job::LocalizableMessage')),
                'progress' => VAPI::Bindings::IntegerType.instance,
            },
            RestoreJobStatus,
            false,
            nil)
    end