Class List Method List File List

# Class: Com::Vmware::Content::Configuration

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

## Overview

The ``Com::Vmware::Content::Configuration`` class provides methods to configure the global settings of the Content Library Service.

     The configuration settings are used by the Content Library Service to control the behavior of various operations.

## Instance Method Summary (collapse)

- - (Com::Vmware::Content::ConfigurationModel) get

  Retrieves the current configuration values.

- - (Configuration) initialize(config) constructor

  Constructs a new instance.

- - (Void) update(model)

  Updates the configuration.

## Constructor Details

### - (`Configuration`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    60
    61
    62
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 60

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Com::Vmware::Content::ConfigurationModel`) get

Retrieves the current configuration values.

Returns:

- (`Com::Vmware::Content::ConfigurationModel`) —

  The :class:`Com::Vmware::Content::ConfigurationModel` instance representing the configuration of the Content Library Service.

    83
    84
    85
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 83

    def get()
        invoke_with_info(@@get_info)
    end

### - (`Void`) update(model)

Updates the configuration. The update is incremental. Any field in the :class:`Com::Vmware::Content::ConfigurationModel` class that is nil will not be modified. Note that this update method doesn’t guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

Parameters:

- model (`Com::Vmware::Content::ConfigurationModel`) —

  The :class:`Com::Vmware::Content::ConfigurationModel` specifying the settings to update.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::InvalidArgument`) —

  if one of the configuration properties is not within the proper range.

    72
    73
    74
    75
    76
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content.rb', line 72

    def update(model)
        invoke_with_info(@@update_info, {
            'model' => model,
        })
    end