Class List Method List File List

# Class: Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType

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

## Overview

The ``Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType`` enumerated type defines the types of endpoints used to download the file.

## Constant Summary

HTTPS =

      EndpointType.new('HTTPS')

DIRECT =

      EndpointType.new('DIRECT')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType) direct

  A direct download endpoint indicating the location of the file on storage.

- - (Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType) https

  An https download endpoint.

## Class Method Summary (collapse)

- + (VAPI::Bindings::EnumType) binding_type

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

- + (EndpointType) from_string(value)

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

## Instance Attribute Details

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType`) direct

A direct download endpoint indicating the location of the file on storage. The caller is responsible for retrieving the file from the storage location directly.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType`)

    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 315

    class EndpointType < 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.downloadsession.file.endpoint_type',
                    EndpointType)
            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 [EndpointType] 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
                    EndpointType.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] https
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType]
        #     An https download endpoint.
        HTTPS = EndpointType.new('HTTPS')

        # @!attribute [rw] direct
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType]
        #     A direct download endpoint indicating the location of the file on storage. The caller is responsible for retrieving the file from the storage location directly.
        DIRECT = EndpointType.new('DIRECT')

    end

### - (`Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType`) https

An https download endpoint.

Returns:

- (`Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType`)

    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 315

    class EndpointType < 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.downloadsession.file.endpoint_type',
                    EndpointType)
            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 [EndpointType] 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
                    EndpointType.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] https
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType]
        #     An https download endpoint.
        HTTPS = EndpointType.new('HTTPS')

        # @!attribute [rw] direct
        #     @return [Com::Vmware::Content::Library::Item::Downloadsession::File::EndpointType]
        #     A direct download endpoint indicating the location of the file on storage. The caller is responsible for retrieving the file from the storage location directly.
        DIRECT = EndpointType.new('DIRECT')

    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

    321
    322
    323
    324
    325
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 321

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.content.library.item.downloadsession.file.endpoint_type',
            EndpointType)
    end

### + (`EndpointType`) 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:

- (`EndpointType`) —

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

    332
    333
    334
    335
    336
    337
    338
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item/downloadsession.rb', line 332

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