Class List Method List File List

# Class: Com::Vmware::Content::Library::ItemService::FindSpec

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

## Overview

The ``Com::Vmware::Content::Library::Item::FindSpec`` class specifies the properties that can be used as a filter to find library items. When multiple fields are specified, all properties of the item must match the specification.

## Instance Attribute Summary (collapse)

- - (Boolean?) cached

  Whether the item is cached.

- - (String?) library_id

  The identifier of the library containing the item.

- - (String?) name

  The name of the library item.

- - (String?) source_id

  The identifier of the library item as reported by the publisher.

- - (String?) type

  The type of the library item.

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

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

  Constructs a new instance.

## Constructor Details

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

    373
    374
    375
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 373

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

## Instance Attribute Details

### - (`Boolean`?) cached

Whether the item is cached. Possible values are ‘true’ or ‘false’. See :attr:`Com::Vmware::Content::Library::ItemModel.cached` . If not specified all library items are searched.

Returns:

- (`Boolean`, `nil`)

    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 342

    class FindSpec < 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.library.item.find_spec',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    FindSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :library_id,
                      :source_id,
                      :type,
                      :cached

        # 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`?) library_id

The identifier of the library containing the item. See :attr:`Com::Vmware::Content::Library::ItemModel.library_id` . If not specified all libraries are searched.

Returns:

- (`String`, `nil`)

    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 342

    class FindSpec < 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.library.item.find_spec',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    FindSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :library_id,
                      :source_id,
                      :type,
                      :cached

        # 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

The name of the library item. The name is case-insensitive. See :attr:`Com::Vmware::Content::Library::ItemModel.name` . If not specified all library item names are searched.

Returns:

- (`String`, `nil`)

    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 342

    class FindSpec < 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.library.item.find_spec',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    FindSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :library_id,
                      :source_id,
                      :type,
                      :cached

        # 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`?) source_id

The identifier of the library item as reported by the publisher. See :attr:`Com::Vmware::Content::Library::ItemModel.source_id` . If not specified all library items are searched.

Returns:

- (`String`, `nil`)

    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 342

    class FindSpec < 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.library.item.find_spec',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    FindSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :library_id,
                      :source_id,
                      :type,
                      :cached

        # 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`?) type

The type of the library item. The type is case-insensitive. See :attr:`Com::Vmware::Content::Library::ItemModel.type` . If not specified all types are searched.

Returns:

- (`String`, `nil`)

    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 342

    class FindSpec < 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.library.item.find_spec',
                    {
                        'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                        'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                        'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
                    },
                    FindSpec,
                    false,
                    nil)
            end
        end

        attr_accessor :name,
                      :library_id,
                      :source_id,
                      :type,
                      :cached

        # 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

    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/content/library.rb', line 348

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.content.library.item.find_spec',
            {
                'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'library_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'source_id' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::IdType.new),
                'type' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                'cached' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::BooleanType.instance),
            },
            FindSpec,
            false,
            nil)
    end