Class List Method List File List

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

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

## Instance Attribute Summary (collapse)

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

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

- - (Com::Vmware::Vcenter::Ovf::LibraryItem::DeployableIdentity?) resource_id

  Identifier of the deployed resource entity.

- - (Boolean) succeeded

  Whether the ``deploy`` 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)

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

  Constructs a new instance.

## Constructor Details

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

    772
    773
    774
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 772

    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 ``deploy`` method . If nil , no errors, warnings, or informational messages were reported by the ``deploy`` method .

Returns:

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

    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 745

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

        attr_accessor :succeeded,
                      :resource_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

### - (`Com::Vmware::Vcenter::Ovf::LibraryItem::DeployableIdentity`?) resource_id

Identifier of the deployed resource entity. If nil , the ``deploy`` method failed and :attr:`Com::Vmware::Vcenter::Ovf::LibraryItem::DeploymentResult.error` will describe the error(s) that caused the failure.

Returns:

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

    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 745

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

        attr_accessor :succeeded,
                      :resource_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 ``deploy`` method completed successfully.

Returns:

- (`Boolean`)

    745
    746
    747
    748
    749
    750
    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    763
    764
    765
    766
    767
    768
    769
    770
    771
    772
    773
    774
    775
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 745

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

        attr_accessor :succeeded,
                      :resource_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

    751
    752
    753
    754
    755
    756
    757
    758
    759
    760
    761
    762
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/ovf.rb', line 751

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