Class: Com::Vmware::Vcenter::Datastore::Summary

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

Overview

The ``Com::Vmware::Vcenter::Datastore::Summary`` class contains commonly used information about a datastore.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Summary) 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) 



915
916
917
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 915

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

Instance Attribute Details

- (Fixnum?) capacity

Capacity of this datastore, in bytes. 


 The server periodically updates this value.

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

Returns:

  • (Fixnum, nil) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 884

class Summary < 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.summary',
                {
                    'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                    'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :datastore,
                  :name,
                  :type,
                  :free_space,
                  :capacity

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

Identifier of the datastore.

Returns:

  • (String) 


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 884

class Summary < 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.summary',
                {
                    'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                    'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :datastore,
                  :name,
                  :type,
                  :free_space,
                  :capacity

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


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 884

class Summary < 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.summary',
                {
                    'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                    'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :datastore,
                  :name,
                  :type,
                  :free_space,
                  :capacity

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


884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 884

class Summary < 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.summary',
                {
                    'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                    'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :datastore,
                  :name,
                  :type,
                  :free_space,
                  :capacity

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

Returns:



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 884

class Summary < 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.summary',
                {
                    'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
                    'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                },
                Summary,
                false,
                nil)
        end
    end

    attr_accessor :datastore,
                  :name,
                  :type,
                  :free_space,
                  :capacity

    # 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 



890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 890

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.vcenter.datastore.summary',
        {
            'datastore' => VAPI::Bindings::IdType.new(resource_types='Datastore'),
            'name' => VAPI::Bindings::StringType.instance,
            'type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Vcenter::Datastore::Type'),
            'free_space' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            'capacity' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
        },
        Summary,
        false,
        nil)
end