Class: Com::Vmware::Vcenter::Folder::Type

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

Overview

The ``Com::Vmware::Vcenter::Folder::Type`` enumerated type defines the type of a vCenter Server folder. The type of a folder determines what what kinds of children can be contained in the folder.

Constant Summary

DATACENTER = 
Type.new('DATACENTER')
DATASTORE = 
Type.new('DATASTORE')
HOST = 
Type.new('HOST')
NETWORK = 
Type.new('NETWORK')
VIRTUAL_MACHINE = 
Type.new('VIRTUAL_MACHINE')

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

- (Com::Vmware::Vcenter::Folder::Type) datacenter

A folder that can contain datacenters.

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1206

class Type < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vcenter.folder.type',
                Type)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [Type] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                Type.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] datacenter
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datacenters.
    DATACENTER = Type.new('DATACENTER')

    # @!attribute [rw] datastore
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datastores.
    DATASTORE = Type.new('DATASTORE')

    # @!attribute [rw] host
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain compute resources (hosts and clusters).
    HOST = Type.new('HOST')

    # @!attribute [rw] network
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain networkds.
    NETWORK = Type.new('NETWORK')

    # @!attribute [rw] virtual_machine
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain virtual machines.
    VIRTUAL_MACHINE = Type.new('VIRTUAL_MACHINE')

end

- (Com::Vmware::Vcenter::Folder::Type) datastore

A folder that can contain datastores.

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1206

class Type < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vcenter.folder.type',
                Type)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [Type] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                Type.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] datacenter
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datacenters.
    DATACENTER = Type.new('DATACENTER')

    # @!attribute [rw] datastore
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datastores.
    DATASTORE = Type.new('DATASTORE')

    # @!attribute [rw] host
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain compute resources (hosts and clusters).
    HOST = Type.new('HOST')

    # @!attribute [rw] network
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain networkds.
    NETWORK = Type.new('NETWORK')

    # @!attribute [rw] virtual_machine
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain virtual machines.
    VIRTUAL_MACHINE = Type.new('VIRTUAL_MACHINE')

end

- (Com::Vmware::Vcenter::Folder::Type) host

A folder that can contain compute resources (hosts and clusters).

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1206

class Type < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vcenter.folder.type',
                Type)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [Type] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                Type.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] datacenter
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datacenters.
    DATACENTER = Type.new('DATACENTER')

    # @!attribute [rw] datastore
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datastores.
    DATASTORE = Type.new('DATASTORE')

    # @!attribute [rw] host
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain compute resources (hosts and clusters).
    HOST = Type.new('HOST')

    # @!attribute [rw] network
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain networkds.
    NETWORK = Type.new('NETWORK')

    # @!attribute [rw] virtual_machine
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain virtual machines.
    VIRTUAL_MACHINE = Type.new('VIRTUAL_MACHINE')

end

- (Com::Vmware::Vcenter::Folder::Type) network

A folder that can contain networkds.

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1206

class Type < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vcenter.folder.type',
                Type)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [Type] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                Type.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] datacenter
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datacenters.
    DATACENTER = Type.new('DATACENTER')

    # @!attribute [rw] datastore
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datastores.
    DATASTORE = Type.new('DATASTORE')

    # @!attribute [rw] host
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain compute resources (hosts and clusters).
    HOST = Type.new('HOST')

    # @!attribute [rw] network
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain networkds.
    NETWORK = Type.new('NETWORK')

    # @!attribute [rw] virtual_machine
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain virtual machines.
    VIRTUAL_MACHINE = Type.new('VIRTUAL_MACHINE')

end

- (Com::Vmware::Vcenter::Folder::Type) virtual_machine

A folder that can contain virtual machines.

Returns:



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1206

class Type < VAPI::Bindings::VapiEnum

    class << self
        # Holds (gets or creates) the binding type metadata for this enumeration type.
        # @scope class
        # @return [VAPI::Bindings::EnumType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::EnumType.new(
                'com.vmware.vcenter.folder.type',
                Type)
        end

        # Converts from a string value (perhaps off the wire) to an instance
        # of this enum type.
        # @param value [String] the actual value of the enum instance
        # @return [Type] the instance found for the value, otherwise
        #         an unknown instance will be built for the value
        def from_string(value)
            begin
                const_get(value)
            rescue NameError
                Type.new('UNKNOWN', value)
            end
        end
    end

    private

    # Constructs a new instance.
    # @param value [String] the actual value of the enum instance
    # @param unknown [String] the unknown value when value is 'UKNOWN'
    def initialize(value, unknown=nil)
        super(self.class.binding_type, value, unknown)
    end

    public

    # @!attribute [rw] datacenter
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datacenters.
    DATACENTER = Type.new('DATACENTER')

    # @!attribute [rw] datastore
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain datastores.
    DATASTORE = Type.new('DATASTORE')

    # @!attribute [rw] host
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain compute resources (hosts and clusters).
    HOST = Type.new('HOST')

    # @!attribute [rw] network
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain networkds.
    NETWORK = Type.new('NETWORK')

    # @!attribute [rw] virtual_machine
    #     @return [Com::Vmware::Vcenter::Folder::Type]
    #     A folder that can contain virtual machines.
    VIRTUAL_MACHINE = Type.new('VIRTUAL_MACHINE')

end

Class Method Details

+ (VAPI::Bindings::EnumType) binding_type

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

Returns:

  • (VAPI::Bindings::EnumType) —

    the binding type 



1212
1213
1214
1215
1216
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1212

def binding_type
    @binding_type ||= VAPI::Bindings::EnumType.new(
        'com.vmware.vcenter.folder.type',
        Type)
end

+ (Type) from_string(value)

Converts from a string value (perhaps off the wire) to an instance of this enum type.

Parameters:

  • value (String) —

    the actual value of the enum instance

Returns:

  • (Type) —

    the instance found for the value, otherwise an unknown instance will be built for the value 



1223
1224
1225
1226
1227
1228
1229
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 1223

def from_string(value)
    begin
        const_get(value)
    rescue NameError
        Type.new('UNKNOWN', value)
    end
end