Class: Com::Vmware::Appliance::Recovery::RestoreService::RestoreRequest

Inherits:
VAPI::Bindings::VapiStruct
  • Object
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::RestoreRequest`` class Structure representing requested restore piece

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (RestoreRequest) 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) 



474
475
476
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 474

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

Instance Attribute Details

- (String?) backup_password

a password for a backup piece backupPassword If no password then the piece will not be decrypted

Returns:

  • (String, nil) 


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 443

class RestoreRequest < 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.restore_request',
                {
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
                    'location' => VAPI::Bindings::StringType.instance,
                    'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                },
                RestoreRequest,
                false,
                nil)
        end
    end

    attr_accessor :backup_password,
                  :location_type,
                  :location,
                  :location_user,
                  :location_password

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

path or url

Returns:

  • (String) 


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 443

class RestoreRequest < 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.restore_request',
                {
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
                    'location' => VAPI::Bindings::StringType.instance,
                    'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                },
                RestoreRequest,
                false,
                nil)
        end
    end

    attr_accessor :backup_password,
                  :location_type,
                  :location,
                  :location_user,
                  :location_password

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

password for location locationPassword Password for the specified user if login is required at this location.

Returns:

  • (String, nil) 


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 443

class RestoreRequest < 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.restore_request',
                {
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
                    'location' => VAPI::Bindings::StringType.instance,
                    'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                },
                RestoreRequest,
                false,
                nil)
        end
    end

    attr_accessor :backup_password,
                  :location_type,
                  :location,
                  :location_user,
                  :location_password

    # 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::LocationType) location_type

a type of location

Returns:

  • (Com::Vmware::Appliance::Recovery::Restore::LocationType) 


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 443

class RestoreRequest < 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.restore_request',
                {
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
                    'location' => VAPI::Bindings::StringType.instance,
                    'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                },
                RestoreRequest,
                false,
                nil)
        end
    end

    attr_accessor :backup_password,
                  :location_type,
                  :location,
                  :location_user,
                  :location_password

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

username for location locationUser User name for this location if login is required.

Returns:

  • (String, nil) 


443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 443

class RestoreRequest < 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.restore_request',
                {
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
                    'location' => VAPI::Bindings::StringType.instance,
                    'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                },
                RestoreRequest,
                false,
                nil)
        end
    end

    attr_accessor :backup_password,
                  :location_type,
                  :location,
                  :location_user,
                  :location_password

    # 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 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery.rb', line 449

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.recovery.restore.restore_request',
        {
            'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
            'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Restore::LocationType'),
            'location' => VAPI::Bindings::StringType.instance,
            'location_user' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'location_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
        },
        RestoreRequest,
        false,
        nil)
end