Class: Com::Vmware::Content::Library::Item::UpdateSessionModel::State

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

Overview

The state of an update session.

Constant Summary

ACTIVE = 
State.new('ACTIVE')
DONE = 
State.new('DONE')
ERROR = 
State.new('ERROR')
CANCELED = 
State.new('CANCELED')

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

- (Com::Vmware::Content::Library::Item::UpdateSessionModel::State) active

The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1255

class State < 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.content.library.item.update_session_model.state',
                State)
        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 [State] 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
                State.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] active
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] done
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is done and all its effects are now visible.
    DONE = State.new('DONE')

    # @!attribute [rw] error
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     There was an error during the session.
    ERROR = State.new('ERROR')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session has been canceled.
    CANCELED = State.new('CANCELED')

end

- (Com::Vmware::Content::Library::Item::UpdateSessionModel::State) canceled

The session has been canceled.

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1255

class State < 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.content.library.item.update_session_model.state',
                State)
        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 [State] 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
                State.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] active
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] done
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is done and all its effects are now visible.
    DONE = State.new('DONE')

    # @!attribute [rw] error
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     There was an error during the session.
    ERROR = State.new('ERROR')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session has been canceled.
    CANCELED = State.new('CANCELED')

end

- (Com::Vmware::Content::Library::Item::UpdateSessionModel::State) done

The session is done and all its effects are now visible.

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1255

class State < 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.content.library.item.update_session_model.state',
                State)
        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 [State] 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
                State.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] active
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] done
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is done and all its effects are now visible.
    DONE = State.new('DONE')

    # @!attribute [rw] error
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     There was an error during the session.
    ERROR = State.new('ERROR')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session has been canceled.
    CANCELED = State.new('CANCELED')

end

- (Com::Vmware::Content::Library::Item::UpdateSessionModel::State) error

There was an error during the session.

Returns:



1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1255

class State < 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.content.library.item.update_session_model.state',
                State)
        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 [State] 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
                State.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] active
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is currently active. This is the initial state when the session is created. Files may be uploaded by the client or pulled by the Content Library Service at this stage.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] done
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session is done and all its effects are now visible.
    DONE = State.new('DONE')

    # @!attribute [rw] error
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     There was an error during the session.
    ERROR = State.new('ERROR')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
    #     The session has been canceled.
    CANCELED = State.new('CANCELED')

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 



1261
1262
1263
1264
1265
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1261

def binding_type
    @binding_type ||= VAPI::Bindings::EnumType.new(
        'com.vmware.content.library.item.update_session_model.state',
        State)
end

+ (State) 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:

  • (State) —

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



1272
1273
1274
1275
1276
1277
1278
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1272

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