Class List Method List File List

# Class: Com::Vmware::Content::ConfigurationModel

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Content::ConfigurationModel
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb

## Overview

The ``Com::Vmware::Content::ConfigurationModel`` class defines the global settings of the Content Library Service.

## Instance Attribute Summary (collapse)

- - (Boolean) automatic_sync_enabled

  Whether automatic synchronization is enabled.

- - (Fixnum) automatic_sync_start_hour

  The hour at which the automatic synchronization will start.

- - (Fixnum) automatic_sync_stop_hour

  The hour at which the automatic synchronization will stop.

- - (Fixnum) maximum_concurrent_item_syncs

  The maximum allowed number of library items to synchronize concurrently from remote libraries.

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

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

  Constructs a new instance.

## Constructor Details

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

    1055
    1056
    1057
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1055

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

## Instance Attribute Details

### - (`Boolean`) automatic_sync_enabled

Whether automatic synchronization is enabled.

     When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the   :attr:`Com::Vmware::Content::Library::SubscriptionInfo.automatic_sync_enabled`   flag turned on will be synchronized every hour between   :attr:`Com::Vmware::Content::ConfigurationModel.automatic_sync_start_hour`   and   :attr:`Com::Vmware::Content::ConfigurationModel.automatic_sync_stop_hour`  .

This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`Boolean`)

    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1026

    class ConfigurationModel < 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.content.configuration_model',
                    {
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'automatic_sync_start_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'automatic_sync_stop_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_concurrent_item_syncs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ConfigurationModel,
                    false,
                    nil)
            end
        end

        attr_accessor :automatic_sync_enabled,
                      :automatic_sync_start_hour,
                      :automatic_sync_stop_hour,
                      :maximum_concurrent_item_syncs

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

The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`Fixnum`)

    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1026

    class ConfigurationModel < 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.content.configuration_model',
                    {
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'automatic_sync_start_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'automatic_sync_stop_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_concurrent_item_syncs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ConfigurationModel,
                    false,
                    nil)
            end
        end

        attr_accessor :automatic_sync_enabled,
                      :automatic_sync_start_hour,
                      :automatic_sync_stop_hour,
                      :maximum_concurrent_item_syncs

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

The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive. This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`Fixnum`)

    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1026

    class ConfigurationModel < 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.content.configuration_model',
                    {
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'automatic_sync_start_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'automatic_sync_stop_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_concurrent_item_syncs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ConfigurationModel,
                    false,
                    nil)
            end
        end

        attr_accessor :automatic_sync_enabled,
                      :automatic_sync_start_hour,
                      :automatic_sync_stop_hour,
                      :maximum_concurrent_item_syncs

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

The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity.

     This setting is global across all subscribed libraries.

This field is not used for the ``create`` method . It will always be present in the result of the ``get`` or ``list`` methods . It is optional for the ``update`` method .

Returns:

- (`Fixnum`)

    1026
    1027
    1028
    1029
    1030
    1031
    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    1045
    1046
    1047
    1048
    1049
    1050
    1051
    1052
    1053
    1054
    1055
    1056
    1057
    1058
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1026

    class ConfigurationModel < 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.content.configuration_model',
                    {
                        'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                        'automatic_sync_start_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'automatic_sync_stop_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                        'maximum_concurrent_item_syncs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                    },
                    ConfigurationModel,
                    false,
                    nil)
            end
        end

        attr_accessor :automatic_sync_enabled,
                      :automatic_sync_start_hour,
                      :automatic_sync_stop_hour,
                      :maximum_concurrent_item_syncs

        # 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

    1032
    1033
    1034
    1035
    1036
    1037
    1038
    1039
    1040
    1041
    1042
    1043
    1044
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 1032

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.configuration_model',
            {
                'automatic_sync_enabled' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                'automatic_sync_start_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'automatic_sync_stop_hour' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
                'maximum_concurrent_item_syncs' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IntegerType.instance),
            },
            ConfigurationModel,
            false,
            nil)
    end