Class List Method List File List

# Class: Com::Vmware::Content::Library::SubscriptionInfo

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

## Overview

The ``Com::Vmware::Content::Library::SubscriptionInfo`` class defines the subscription behavior for a subscribed library.

## Defined Under Namespace

Classes: AuthenticationMethod

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod) authentication_method

  Indicate how the subscribed library should authenticate ( ``BASIC``, ``NONE`` ) with the published library endpoint.

- - (Boolean) automatic_sync_enabled

  Whether the library should participate in automatic library synchronization.

- - (Boolean) on_demand

  Indicates whether a library item’s content will be synchronized only on demand.

- - (String) password

  The password to use when authenticating.

- - (String) ssl_thumbprint

  An optional SHA-1 hash of the SSL certificate for the remote endpoint.

- - (URI) subscription_url

  The URL of the endpoint where the metadata for the remotely published library is being served.

- - (String) user_name

  The username to use when authenticating.

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

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

  Constructs a new instance.

## Constructor Details

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

    1047
    1048
    1049
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1047

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

## Instance Attribute Details

### - (`Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod`) authentication_method

Indicate how the subscribed library should authenticate ( ``BASIC``, ``NONE`` ) with the published library endpoint. 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 optional for the ``update`` method .

Returns:

- (`Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`Boolean`) automatic_sync_enabled

Whether the library should participate in automatic library synchronization. In order for automatic synchronization to happen, the global :attr:`Com::Vmware::Content::ConfigurationModel.automatic_sync_enabled` option must also be true. The subscription is still active even when automatic synchronization is turned off, but synchronization is only activated with an explicit call to :func:`Com::Vmware::Content::SubscribedLibrary.sync` or :func:`Com::Vmware::Content::Library::SubscribedItem.sync` . In other words, manual synchronization is still available even when automatic synchronization is disabled. 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 optional for the ``update`` method .

Returns:

- (`Boolean`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`Boolean`) on_demand

Indicates whether a library item’s content will be synchronized only on demand.

     If this is set to  ``true`` , then the library item's metadata will be synchronized but the item's content (its files) will not be synchronized. The Content Library Service will synchronize the content upon request only. This can cause the first use of the content to have a noticeable delay.

     Items without synchronized content can be forcefully synchronized in advance using the   :func:`Com::Vmware::Content::Library::SubscribedItem.sync`   call with  ``forceSyncContent``  set to true. Once content has been synchronized, the content can removed with the   :func:`Com::Vmware::Content::Library::SubscribedItem.evict`   call.

     If this value is set to  ``false`` , all content will be synchronized in advance.

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 optional for the ``update`` method .

Returns:

- (`Boolean`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`String`) password

The password to use when authenticating.

     The password must be set when using a password-based authentication method; empty strings are not allowed.

This field is optional for the ``create`` method . It will not be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`String`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`String`) ssl_thumbprint

An optional SHA-1 hash of the SSL certificate for the remote endpoint.

     If this value is defined the SSL certificate will be verified by comparing it to the SSL thumbprint. The SSL certificate must verify against the thumbprint. When specified, the standard certificate chain validation behavior is not used. The certificate chain is validated normally if this value is  nil .

This field is optional for the ``create`` method . It will not be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`String`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`URI`) subscription_url

The URL of the endpoint where the metadata for the remotely published library is being served.

     This URL can be the   :attr:`Com::Vmware::Content::Library::PublishInfo.publish_url`   of the published library (for example, https://server/path/lib.json).

     If the source content comes from a published library with   :attr:`Com::Vmware::Content::Library::PublishInfo.persist_json_enabled`  , the subscription URL can be a URL pointing to the library JSON file on a datastore or remote file system. The supported formats are:

     vSphere 6.5

      * ds:///vmfs/volumes/{uuid}/mylibrary/lib.json (for datastore)
       * nfs://server/path/mylibrary/lib.json (for NFSv3 server on vCenter Server Appliance)
       * nfs://server/path/mylibrary/lib.json?version=4 (for NFSv4 server on vCenter Server Appliance)
       * smb://server/path/mylibrary/lib.json (for SMB server)

     vSphere 6.0

      * file://server/mylibrary/lib.json (for UNC server on vCenter Server for Windows)
       * file:///path/mylibrary/lib.json (for local file system)

     When you specify a DS subscription URL, the datastore must be on the same vCenter Server as the subscribed library. When you specify an NFS or SMB subscription URL, the   :attr:`Com::Vmware::Content::Library::StorageBacking.storage_uri`   of the subscribed library must be on the same remote file server and should share a common parent path with the subscription URL.

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 optional for the ``update`` method .

Returns:

- (`URI`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        end

    end

### - (`String`) user_name

The username to use when authenticating.

     The username must be set when using a password-based authentication method. Empty strings are allowed for usernames.

This field is optional for the ``create`` method . It is optional in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`String`)

    1012
    1013
    1014
    1015
    1016
    1017
    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1012

    class SubscriptionInfo < 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.subscription_info',
                    {
                        'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                        'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                        'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    SubscriptionInfo,
                    false,
                    nil)
            end
        end

        attr_accessor :authentication_method,
                      :automatic_sync_enabled,
                      :on_demand,
                      :password,
                      :ssl_thumbprint,
                      :subscription_url,
                      :user_name

        # 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

        # Indicate how the subscribed library should authenticate with the published library endpoint.
        # @!attribute [rw] basic
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require HTTP Basic authentication matching a specified username and password.
        # @!attribute [rw] none
        #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
        #     Require no authentication.
        class AuthenticationMethod < 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.subscription_info.authentication_method',
                        AuthenticationMethod)
                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 [AuthenticationMethod] 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
                        AuthenticationMethod.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] basic
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require HTTP Basic authentication matching a specified username and password.
            BASIC = AuthenticationMethod.new('BASIC')

            # @!attribute [rw] none
            #     @return [Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod]
            #     Require no authentication.
            NONE = AuthenticationMethod.new('NONE')

        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

    1018
    1019
    1020
    1021
    1022
    1023
    1024
    1025
    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 1018

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.subscription_info',
            {
                'authentication_method' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::Library::SubscriptionInfo::AuthenticationMethod')),
                'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'on_demand' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'password' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SecretType.instance),
                'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'subscription_url' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::URIType.instance),
                'user_name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            SubscriptionInfo,
            false,
            nil)
    end