Class: Com::Vmware::Content::Library::Item::DownloadSessionModel::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 the download session.

Constant Summary

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

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Attribute Details

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

The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1060

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.download_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::DownloadSessionModel::State]
    #     The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::DownloadSessionModel::State]
    #     The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.
    CANCELED = State.new('CANCELED')

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

end

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

The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1060

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.download_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::DownloadSessionModel::State]
    #     The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::DownloadSessionModel::State]
    #     The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.
    CANCELED = State.new('CANCELED')

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

end

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

Indicates there was an error during the session lifecycle.

Returns:



1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1060

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.download_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::DownloadSessionModel::State]
    #     The session is active. Individual files may be in the process of being transferred and may become ready for download at different times.
    ACTIVE = State.new('ACTIVE')

    # @!attribute [rw] canceled
    #     @return [Com::Vmware::Content::Library::Item::DownloadSessionModel::State]
    #     The session has been canceled. On-going downloads may fail. The session will stay in this state until it is either deleted by the user or automatically cleaned up by the Content Library Service.
    CANCELED = State.new('CANCELED')

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

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 



1066
1067
1068
1069
1070
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1066

def binding_type
    @binding_type ||= VAPI::Bindings::EnumType.new(
        'com.vmware.content.library.item.download_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 



1077
1078
1079
1080
1081
1082
1083
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 1077

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