Class List Method List File List

# Class: Com::Vmware::Vcenter::Datastore::Info

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

## Overview

The ``Com::Vmware::Vcenter::Datastore::Info`` class contains information about a datastore.

## Instance Attribute Summary (collapse)

- - (Boolean) accessible

  Whether or not this datastore is accessible.

- - (Fixnum?) free_space

  Available space of this datastore, in bytes.

- - (Boolean) multiple_host_access

  Whether or not ore than one host in the datacenter has been configured with access to the datastore.

- - (String) name

  Name of the datastore.

- - (Boolean) thin_provisioning_supported

  Whether or not the datastore supports thin provisioning on a per file basis.

- - (Com::Vmware::Vcenter::Datastore::Type) type

  Type ( ``VMFS``, ``NFS``, ``NFS41``, ``CIFS``, ``VSAN``, ``VFFS``, ``VVOL`` ) of the datastore.

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

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

  Constructs a new instance.

## Constructor Details

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

    798
    799
    800
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 798

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

## Instance Attribute Details

### - (`Boolean`) accessible

Whether or not this datastore is accessible.

Returns:

- (`Boolean`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

        # 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

### - (`Fixnum`?) free_space

Available space of this datastore, in bytes.

     The server periodically updates this value.

This field will be nil if the available space of this datastore is not known.

Returns:

- (`Fixnum`, `nil`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

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

Whether or not ore than one host in the datacenter has been configured with access to the datastore.

Returns:

- (`Boolean`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

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

Name of the datastore.

Returns:

- (`String`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

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

Whether or not the datastore supports thin provisioning on a per file basis. When thin provisioning is used, backing storage is lazily allocated.

Returns:

- (`Boolean`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

        # 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::Datastore::Type`) type

Type ( ``VMFS``, ``NFS``, ``NFS41``, ``CIFS``, ``VSAN``, ``VFFS``, ``VVOL`` ) of the datastore.

Returns:

- (`Com::Vmware::Vcenter::Datastore::Type`)

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

    class Info < 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.datastore.info',
                    {
                        'name' => VAPI::Bindings::StringType.instance,
                        'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                        'accessible' => VAPI::Bindings::BooleanType.instance,
                        'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                        'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :type,
                      :accessible,
                      :free_space,
                      :multiple_host_access,
                      :thin_provisioning_supported

        # 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

    771
    772
    773
    774
    775
    776
    777
    778
    779
    780
    781
    782
    783
    784
    785
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 771

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.datastore.info',
            {
                'name' => VAPI::Bindings::StringType.instance,
                'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                'accessible' => VAPI::Bindings::BooleanType.instance,
                'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'multiple_host_access' => VAPI::Bindings::BooleanType.instance,
                'thin_provisioning_supported' => VAPI::Bindings::BooleanType.instance,
            },
            Info,
            false,
            nil)
    end