Class: Com::Vmware::Content::SubscribedLibrary::ProbeResult
- Inherits:
-
VAPI::Bindings::VapiStruct
- Object
- VAPI::Bindings::VapiStruct
- Com::Vmware::Content::SubscribedLibrary::ProbeResult
- Defined in:
- /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb
Overview
The ``Com::Vmware::Content::SubscribedLibrary::ProbeResult`` class defines the subscription information probe result. This describes whether using a given subscription URL is successful or if there are access problems, such as SSL errors.
Defined Under Namespace
Classes: Status
Instance Attribute Summary (collapse)
-
- (Array<Com::Vmware::Vapi::Std::LocalizableMessage>) error_messages
If the probe result is in an error status, this field will contain the detailed error messages.
-
- (String?) ssl_thumbprint
The SSL thumbprint for the remote endpoint.
-
- (Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status) status
The status of probe result.
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)
-
- (ProbeResult) initialize(ruby_values = nil, struct_value = nil)
constructor
Constructs a new instance.
Constructor Details
- (ProbeResult) initialize(ruby_values = nil, struct_value = nil)
Constructs a new instance.
784 785 786 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 784 def initialize(ruby_values=nil, struct_value=nil) super(self.class.binding_type, ruby_values, struct_value) end |
Instance Attribute Details
- (Array<Com::Vmware::Vapi::Std::LocalizableMessage>) error_messages
If the probe result is in an error status, this field will contain the detailed error messages.
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 757 class ProbeResult < 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.subscribed_library.probe_result', { 'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status'), 'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'error_messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')), }, ProbeResult, false, nil) end end attr_accessor :status, :ssl_thumbprint, :error_messages # 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 ``Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status`` enumerated type defines the error status constants for the probe result. # @!attribute [rw] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . class Status < 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.subscribed_library.probe_result.status', Status) 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 [Status] 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 Status.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] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. SUCCESS = Status.new('SUCCESS') # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. INVALID_URL = Status.new('INVALID_URL') # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. TIMED_OUT = Status.new('TIMED_OUT') # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. HOST_NOT_FOUND = Status.new('HOST_NOT_FOUND') # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. RESOURCE_NOT_FOUND = Status.new('RESOURCE_NOT_FOUND') # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. INVALID_CREDENTIALS = Status.new('INVALID_CREDENTIALS') # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . CERTIFICATE_ERROR = Status.new('CERTIFICATE_ERROR') # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . UNKNOWN_ERROR = Status.new('UNKNOWN_ERROR') end end |
- (String?) ssl_thumbprint
The SSL thumbprint for the remote endpoint. An SSL thumbprint is only returned if the host is secured with SSL/TLS.
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 757 class ProbeResult < 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.subscribed_library.probe_result', { 'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status'), 'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'error_messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')), }, ProbeResult, false, nil) end end attr_accessor :status, :ssl_thumbprint, :error_messages # 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 ``Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status`` enumerated type defines the error status constants for the probe result. # @!attribute [rw] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . class Status < 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.subscribed_library.probe_result.status', Status) 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 [Status] 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 Status.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] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. SUCCESS = Status.new('SUCCESS') # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. INVALID_URL = Status.new('INVALID_URL') # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. TIMED_OUT = Status.new('TIMED_OUT') # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. HOST_NOT_FOUND = Status.new('HOST_NOT_FOUND') # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. RESOURCE_NOT_FOUND = Status.new('RESOURCE_NOT_FOUND') # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. INVALID_CREDENTIALS = Status.new('INVALID_CREDENTIALS') # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . CERTIFICATE_ERROR = Status.new('CERTIFICATE_ERROR') # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . UNKNOWN_ERROR = Status.new('UNKNOWN_ERROR') end end |
- (Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status) status
The status of probe result. This will be one of ``SUCCESS``, ``INVALID_URL``, ``TIMED_OUT``, ``HOST_NOT_FOUND``, ``RESOURCE_NOT_FOUND``, ``INVALID_CREDENTIALS``, ``CERTIFICATE_ERROR``, ``UNKNOWN_ERROR`` .
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 757 class ProbeResult < 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.subscribed_library.probe_result', { 'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status'), 'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'error_messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')), }, ProbeResult, false, nil) end end attr_accessor :status, :ssl_thumbprint, :error_messages # 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 ``Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status`` enumerated type defines the error status constants for the probe result. # @!attribute [rw] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . class Status < 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.subscribed_library.probe_result.status', Status) 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 [Status] 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 Status.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] success # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe was successful. SUCCESS = Status.new('SUCCESS') # @!attribute [rw] invalid_url # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the supplied URL was not valid. INVALID_URL = Status.new('INVALID_URL') # @!attribute [rw] timed_out # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the probe timed out while attempting to connect to the URL. TIMED_OUT = Status.new('TIMED_OUT') # @!attribute [rw] host_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the host in the URL could not be found. HOST_NOT_FOUND = Status.new('HOST_NOT_FOUND') # @!attribute [rw] resource_not_found # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the given resource at the URL was not found. RESOURCE_NOT_FOUND = Status.new('RESOURCE_NOT_FOUND') # @!attribute [rw] invalid_credentials # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the connection was rejected due to invalid credentials. INVALID_CREDENTIALS = Status.new('INVALID_CREDENTIALS') # @!attribute [rw] certificate_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates that the provided server certificate thumbprint in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` is invalid. In this case, the returned null should be set in :attr:`Com::Vmware::Content::Library::SubscriptionInfo.ssl_thumbprint` . CERTIFICATE_ERROR = Status.new('CERTIFICATE_ERROR') # @!attribute [rw] unknown_error # @return [Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status] # Indicates an unspecified error different from the other error cases defined in :class:`Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status` . UNKNOWN_ERROR = Status.new('UNKNOWN_ERROR') end end |
Class Method Details
+ (VAPI::Bindings::StructType) binding_type
Holds (gets or creates) the binding type metadata for this structure type.
763 764 765 766 767 768 769 770 771 772 773 774 |
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 763 def binding_type @binding_type ||= VAPI::Bindings::StructType.new( 'com.vmware.content.subscribed_library.probe_result', { 'status' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Content::SubscribedLibrary::ProbeResult::Status'), 'ssl_thumbprint' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance), 'error_messages' => VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage')), }, ProbeResult, false, nil) end |