Class List Method List File List

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

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Content::Library::Item::UpdateSessionModel
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb

## Overview

The ``Com::Vmware::Content::Library::Item::UpdateSessionModel`` class provides information on an active :class:`Com::Vmware::Content::Library::Item::UpdateSession` resource.

## Defined Under Namespace

Classes: State

## Instance Attribute Summary (collapse)

- - (Fixnum) client_progress

  The progress that has been made with the upload.

- - (Com::Vmware::Vapi::Std::LocalizableMessage) error_message

  If the session is in the :attr:`Com::Vmware::Content::Library::Item::UpdateSessionModel::State.ERROR` status this property will have more details about the error.

- - (DateTime) expiration_time

  Indicates the time after which the session will expire.

- - (String) id

  The identifier of this update session.

- - (String) library_item_content_version

  The content version of the library item whose content is being modified.

- - (String) library_item_id

  The identifier of the library item to which content will be uploaded or removed.

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

  The current state ( ``ACTIVE``, ``DONE``, ``ERROR``, ``CANCELED`` ) of the update session.

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

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

  Constructs a new instance.

## Constructor Details

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

    1237
    1238
    1239
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1237

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

## Instance Attribute Details

### - (`Fixnum`) client_progress

The progress that has been made with the upload. This property is to be updated by the client during the upload process to indicate the progress of its work in completing the upload. The initial progress is 0 until updated by the client. The maximum value is 100, which indicates that the update is complete. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`Fixnum`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`Com::Vmware::Vapi::Std::LocalizableMessage`) error_message

If the session is in the :attr:`Com::Vmware::Content::Library::Item::UpdateSessionModel::State.ERROR` status this property will have more details about the error. This field is not used for the ``create`` method . It is optional in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`Com::Vmware::Vapi::Std::LocalizableMessage`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`DateTime`) expiration_time

Indicates the time after which the session will expire. The session is guaranteed not to expire earlier than this time. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`DateTime`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`String`) id

The identifier of this update session. This field is not used for the ``create`` method . It will not be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`String`) library_item_content_version

The content version of the library item whose content is being modified. This value is the :attr:`Com::Vmware::Content::Library::ItemModel.content_version` at the time when the session is created for the library item. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`String`) library_item_id

The identifier of the library item to which content will be uploaded or removed. This field must be provided for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

- (`String`)

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    end

### - (`Com::Vmware::Content::Library::Item::UpdateSessionModel::State`) state

The current state ( ``ACTIVE``, ``DONE``, ``ERROR``, ``CANCELED`` ) of the update session. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is not used for the ``update`` method .

Returns:

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

    1202
    1203
    1204
    1205
    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
    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
    1313
    1314
    1315
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1202

    class UpdateSessionModel < 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.content.library.item.update_session_model',
                    {
                        'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                        'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                        'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
                    },
                    UpdateSessionModel,
                    true,
                    ["id"])
            end
        end

        attr_accessor :id,
                      :library_item_id,
                      :library_item_content_version,
                      :error_message,
                      :client_progress,
                      :state,
                      :expiration_time

        # 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

        # The state of an update session.
        # @!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.
        # @!attribute [rw] done
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session is done and all its effects are now visible.
        # @!attribute [rw] error
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     There was an error during the session.
        # @!attribute [rw] canceled
        #     @return [Com::Vmware::Content::Library::Item::UpdateSessionModel::State]
        #     The session has been canceled.
        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

    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

    1208
    1209
    1210
    1211
    1212
    1213
    1214
    1215
    1216
    1217
    1218
    1219
    1220
    1221
    1222
    1223
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1208

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.item.update_session_model',
            {
                'id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'library_item_content_version' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'error_message' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')),
                'client_progress' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'state' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::Item::UpdateSessionModel::State')),
                'expiration_time' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::DateTimeType.instance),
            },
            UpdateSessionModel,
            true,
            ["id"])
    end