Class List Method List File List

# Class: Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType

Inherits:
  VAPI::Bindings::VapiEnum
  - Object
  - VAPI::Bindings::VapiEnum
  - Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb

## Overview

The ``Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType`` enumerated type provides enumeration values for the set of valid authentication scheme types.

## Constant Summary

SESSIONLESS =

      SchemeType.new('SESSIONLESS')

SESSION_AWARE =

      SchemeType.new('SESSION_AWARE')

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType) session_aware

  Indicates that the scheme is a session aware authentication scheme.

- - (Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType) sessionless

  Indicates that the scheme is a session less authentication scheme, the user is authenticated on every method .

## Class Method Summary (collapse)

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

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

- + (SchemeType) from_string(value)

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

## Instance Attribute Details

### - (`Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType`) session_aware

Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a method and logout when a session terminates. A class might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every method .

Returns:

- (`Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType`)

    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 633

    class SchemeType < 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.vapi.metadata.authentication.authentication_info.scheme_type',
                    SchemeType)
            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 [SchemeType] 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
                    SchemeType.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] sessionless
        #     @return [Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType]
        #     Indicates that the scheme is a session less authentication scheme, the user is authenticated on every  method . There is no explicit session establishment.
        SESSIONLESS = SchemeType.new('SESSIONLESS')

        # @!attribute [rw] session_aware
        #     @return [Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType]
        #     Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a  method  and logout when a session terminates. A  class  might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every  method .
        SESSION_AWARE = SchemeType.new('SESSION_AWARE')

    end

### - (`Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType`) sessionless

Indicates that the scheme is a session less authentication scheme, the user is authenticated on every method . There is no explicit session establishment.

Returns:

- (`Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType`)

    633
    634
    635
    636
    637
    638
    639
    640
    641
    642
    643
    644
    645
    646
    647
    648
    649
    650
    651
    652
    653
    654
    655
    656
    657
    658
    659
    660
    661
    662
    663
    664
    665
    666
    667
    668
    669
    670
    671
    672
    673
    674
    675
    676
    677
    678
    679
    680
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 633

    class SchemeType < 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.vapi.metadata.authentication.authentication_info.scheme_type',
                    SchemeType)
            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 [SchemeType] 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
                    SchemeType.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] sessionless
        #     @return [Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType]
        #     Indicates that the scheme is a session less authentication scheme, the user is authenticated on every  method . There is no explicit session establishment.
        SESSIONLESS = SchemeType.new('SESSIONLESS')

        # @!attribute [rw] session_aware
        #     @return [Com::Vmware::Vapi::Metadata::Authentication::AuthenticationInfo::SchemeType]
        #     Indicates that the scheme is a session aware authentication scheme. It requires an explicit login before executing a  method  and logout when a session terminates. A  class  might choose to have a session aware scheme if it wants to associate some state corresponding to the user until the user logs out or if it wants to mitigate the cost of authenticating the user on every  method .
        SESSION_AWARE = SchemeType.new('SESSION_AWARE')

    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

    639
    640
    641
    642
    643
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 639

    def binding_type
        @binding_type ||= VAPI::Bindings::EnumType.new(
            'com.vmware.vapi.metadata.authentication.authentication_info.scheme_type',
            SchemeType)
    end

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

- (`SchemeType`) —

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

    650
    651
    652
    653
    654
    655
    656
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vapi/metadata/authentication.rb', line 650

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