Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::CertificateParams

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::CertificateParams
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb

## Overview

The ``Com::Vmware::Vcenter::Ovf::CertificateParams`` class contains information about the public key certificate used to sign the OVF package. This class will only be returned if the OVF package is signed.

     See   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.deploy`   and   :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.filter`  .

## Instance Attribute Summary (collapse)

- - (Boolean) is_self_signed

  Is the certificate self-signed.

- - (Boolean) is_valid

  Is the certificate chain validated.

- - (String) issuer

  Certificate issuer.

- - (String) subject

  Certificate subject.

- - (Object) type

  Returns the value of attribute type.

- - (String) x509

  The X509 representation of the certificate.

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

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

  Constructs a new instance.

## Constructor Details

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

    1077
    1078
    1079
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1077

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

## Instance Attribute Details

### - (`Boolean`) is_self_signed

Is the certificate self-signed. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`Boolean`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1044

    class CertificateParams < 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.vcenter.ovf.certificate_params',
                    {
                        'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    CertificateParams,
                    false,
                    nil)
            end
        end

        attr_accessor :issuer,
                      :subject,
                      :is_valid,
                      :is_self_signed,
                      :x509,
                      :type

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

### - (`Boolean`) is_valid

Is the certificate chain validated. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`Boolean`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1044

    class CertificateParams < 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.vcenter.ovf.certificate_params',
                    {
                        'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    CertificateParams,
                    false,
                    nil)
            end
        end

        attr_accessor :issuer,
                      :subject,
                      :is_valid,
                      :is_self_signed,
                      :x509,
                      :type

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

### - (`String`) issuer

Certificate issuer. For example: /C=US/ST=California/L=Palo Alto/O=VMware, Inc. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1044

    class CertificateParams < 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.vcenter.ovf.certificate_params',
                    {
                        'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    CertificateParams,
                    false,
                    nil)
            end
        end

        attr_accessor :issuer,
                      :subject,
                      :is_valid,
                      :is_self_signed,
                      :x509,
                      :type

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

### - (`String`) subject

Certificate subject. For example: /C=US/ST=Massachusetts/L=Hopkinton/O=EMC Corporation/OU=EMC Avamar/CN=EMC Corporation. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1044

    class CertificateParams < 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.vcenter.ovf.certificate_params',
                    {
                        'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    CertificateParams,
                    false,
                    nil)
            end
        end

        attr_accessor :issuer,
                      :subject,
                      :is_valid,
                      :is_self_signed,
                      :x509,
                      :type

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

### - (`Object`) type

Returns the value of attribute type

    1067
    1068
    1069
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1067

    def type
      @type
    end

### - (`String`) x509

The X509 representation of the certificate. This field is not used in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Returns:

- (`String`)

    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
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1044

    class CertificateParams < 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.vcenter.ovf.certificate_params',
                    {
                        'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    },
                    CertificateParams,
                    false,
                    nil)
            end
        end

        attr_accessor :issuer,
                      :subject,
                      :is_valid,
                      :is_self_signed,
                      :x509,
                      :type

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

    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    1059
    1060
    1061
    1062
    1063
    1064
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1050

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.certificate_params',
            {
                'issuer' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'subject' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'is_valid' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'is_self_signed' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'x509' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            },
            CertificateParams,
            false,
            nil)
    end