Class List Method List File List

# Class: Com::Vmware::Appliance::Recovery::RestoreService::Metadata

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

## Overview

``Com::Vmware::Appliance::Recovery::Restore::Metadata`` class Structure representing metadata

## Instance Attribute Summary (collapse)

- - (Boolean) applicable

  Does the VCSA match the deployment type, network properties and version of backed up VC.

- - (String) boxname

  Box name is PNID/ FQDN etc.

- - (String) comment

  Custom comment.

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

  Any messages if the backup is not aplicable.

- - (Array<String>) parts

  List of parts included in the backup.

- - (DateTime) timestamp

  Time when this backup was completed.

- - (String) version

  VCSA version.

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

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

  Constructs a new instance.

## Constructor Details

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

    580
    581
    582
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 580

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

## Instance Attribute Details

### - (`Boolean`) applicable

Does the VCSA match the deployment type, network properties and version of backed up VC

Returns:

- (`Boolean`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

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

Box name is PNID/ FQDN etc

Returns:

- (`String`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

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

Custom comment

Returns:

- (`String`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

        # 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::Restore::LocalizableMessage>`) messages

Any messages if the backup is not aplicable

Returns:

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

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

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

List of parts included in the backup.

Returns:

- (`Array<String>`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

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

Time when this backup was completed.

Returns:

- (`DateTime`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

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

VCSA version

Returns:

- (`String`)

    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 545

    class Metadata < 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.metadata',
                    {
                        'timestamp' => VAPI::Bindings::DateTimeType.instance,
                        'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                        'version' => VAPI::Bindings::StringType.instance,
                        'boxname' => VAPI::Bindings::StringType.instance,
                        'comment' => VAPI::Bindings::StringType.instance,
                        'applicable' => VAPI::Bindings::BooleanType.instance,
                        'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
                    },
                    Metadata,
                    false,
                    nil)
            end
        end

        attr_accessor :timestamp,
                      :parts,
                      :version,
                      :boxname,
                      :comment,
                      :applicable,
                      :messages

        # 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

    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 551

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.appliance.recovery.restore.metadata',
            {
                'timestamp' => VAPI::Bindings::DateTimeType.instance,
                'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                'version' => VAPI::Bindings::StringType.instance,
                'boxname' => VAPI::Bindings::StringType.instance,
                'comment' => VAPI::Bindings::StringType.instance,
                'applicable' => VAPI::Bindings::BooleanType.instance,
                'messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocalizableMessage')),
            },
            Metadata,
            false,
            nil)
    end