Class List Method List File List

# Class: Com::Vmware::Content::Library::Item::Storage

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

## Overview

``Com::Vmware::Content::Library::Item::Storage`` is a resource that represents a specific instance of a file stored on a storage backing. Unlike :class:`Com::Vmware::Content::Library::Item::File` , which is abstract, storage represents concrete files on the various storage backings. A file is only represented once in :class:`Com::Vmware::Content::Library::Item::File` , but will be represented multiple times (once for each storage backing) in ``Com::Vmware::Content::Library::Item::Storage`` . The ``Com::Vmware::Content::Library::Item::Storage`` class provides information on the storage backing and the specific location of the file in that backing to privileged users who want direct access to the file on the storage medium.

## Defined Under Namespace

Classes: Info

## Instance Method Summary (collapse)

- - (Array<Com::Vmware::Content::Library::Item::Storage::Info>) get(library_item_id, file_name)

  Retrieves the storage information for a specific file in a library item.

- - (Storage) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Content::Library::Item::Storage::Info>) list(library_item_id)

  Lists all storage items for a given library item.

## Constructor Details

### - (`Storage`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    573
    574
    575
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 573

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

## Instance Method Details

### - (`Array<Com::Vmware::Content::Library::Item::Storage::Info>`) get(library_item_id, file_name)

Retrieves the storage information for a specific file in a library item.

Parameters:

- library_item_id (`String`) —

  Identifier of the library item whose storage information should be retrieved.

- file_name (`String`) —

  Name of the file for which the storage information should be listed.

Returns:

- (`Array<Com::Vmware::Content::Library::Item::Storage::Info>`) —

  The list of all the storage items for the given file within the given library item.

Raises:

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

  if the specified library item does not exist.

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

  if the specified file does not exist in the given library item.

    590
    591
    592
    593
    594
    595
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 590

    def get(library_item_id, file_name)
        invoke_with_info(@@get_info, {
            'library_item_id' => library_item_id,
            'file_name' => file_name,
        })
    end

### - (`Array<Com::Vmware::Content::Library::Item::Storage::Info>`) list(library_item_id)

Lists all storage items for a given library item.

Parameters:

- library_item_id (`String`) —

  Identifier of the library item whose storage information should be listed.

Returns:

- (`Array<Com::Vmware::Content::Library::Item::Storage::Info>`) —

  The list of all storage items for a given library item.

Raises:

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

  if the specified library item does not exist.

    606
    607
    608
    609
    610
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library/item.rb', line 606

    def list(library_item_id)
        invoke_with_info(@@list_info, {
            'library_item_id' => library_item_id,
        })
    end