Class List Method List File List

# Class: Com::Vmware::Vcenter::Ovf::LibraryItem::CreateResult

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Ovf::LibraryItem::CreateResult
  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::LibraryItem::CreateResult`` class defines the result of the ``create`` method . See :func:`Com::Vmware::Vcenter::Ovf::LibraryItem.create` .

## Instance Attribute Summary (collapse)

- - (Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo?) error

  Errors, warnings, and informational messages produced by the ``create`` method .

- - (String?) ovf_library_item_id

  Identifier of the created or updated library item.

- - (Boolean) succeeded

  Whether the ``create`` method completed successfully.

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

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

  Constructs a new instance.

## Constructor Details

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

    1011
    1012
    1013
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 1011

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

## Instance Attribute Details

### - (`Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo`?) error

Errors, warnings, and informational messages produced by the ``create`` method . If nil , no errors, warnings, or informational messages were reported by the ``create`` method .

Returns:

- (`Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo`, `nil`)

    984
    985
    986
    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 984

    class CreateResult < 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.library_item.create_result',
                    {
                        'succeeded' => VAPI::Bindings::BooleanType.instance,
                        'ovf_library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo')),
                    },
                    CreateResult,
                    false,
                    nil)
            end
        end

        attr_accessor :succeeded,
                      :ovf_library_item_id,
                      :error

        # 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`?) ovf_library_item_id

Identifier of the created or updated library item. If nil , the ``create`` method failed and :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::CreateResult.error` will describe the error(s) that caused the failure.

Returns:

- (`String`, `nil`)

    984
    985
    986
    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 984

    class CreateResult < 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.library_item.create_result',
                    {
                        'succeeded' => VAPI::Bindings::BooleanType.instance,
                        'ovf_library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo')),
                    },
                    CreateResult,
                    false,
                    nil)
            end
        end

        attr_accessor :succeeded,
                      :ovf_library_item_id,
                      :error

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

Whether the ``create`` method completed successfully.

Returns:

- (`Boolean`)

    984
    985
    986
    987
    988
    989
    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    1002
    1003
    1004
    1005
    1006
    1007
    1008
    1009
    1010
    1011
    1012
    1013
    1014
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 984

    class CreateResult < 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.library_item.create_result',
                    {
                        'succeeded' => VAPI::Bindings::BooleanType.instance,
                        'ovf_library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo')),
                    },
                    CreateResult,
                    false,
                    nil)
            end
        end

        attr_accessor :succeeded,
                      :ovf_library_item_id,
                      :error

        # 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

    990
    991
    992
    993
    994
    995
    996
    997
    998
    999
    1000
    1001
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 990

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.ovf.library_item.create_result',
            {
                'succeeded' => VAPI::Bindings::BooleanType.instance,
                'ovf_library_item_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'error' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Ovf::LibraryItem::ResultInfo')),
            },
            CreateResult,
            false,
            nil)
    end