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

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::BackupRequest`` class Structure representing requested backup piece

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



303
304
305
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 303

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 The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). backupPassword If no password then the piece will not be encrypted

Returns:

  • (String, nil) 


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

    # 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 comment an optional comment

Returns:

  • (String, nil) 


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

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


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

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


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

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

a type of location

Returns:



268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

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


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

    # 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

a list of optional parts. Run backup parts APIs to get list of optional parts and description

Returns:

  • (Array<String>) 


268
269
270
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
302
303
304
305
306
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/recovery/backup.rb', line 268

class BackupRequest < 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_request',
                {
                    'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
                    'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                    'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
                    'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                BackupRequest,
                false,
                nil)
        end
    end

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

    # 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 



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

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.recovery.backup.job.backup_request',
        {
            'parts' => VAPI::Bindings::ListType.new(VAPI::Bindings::StringType.instance),
            'backup_password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
            'location_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Recovery::Backup::Job::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),
            'comment' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
        },
        BackupRequest,
        false,
        nil)
end