Class: Jamf::AdvancedSearch

Inherits:

CollectionResource

• Object
• JSONObject
• Resource
• CollectionResource
• Jamf::AdvancedSearch

Extended by:

Abstract

Defined in:

lib/jamf/api/abstract_classes/advanced_search.rb

Overview

A building defined in the JSS

Direct Known Subclasses

AdvancedMobileDeviceSearch, AdvancedUserSearch

Constant Summary

OBJECT_MODEL =

Object Model / Attributes See APIObject class documentation for details of how the OBJECT_MODEL hash works.

{

  # @!attribute [r] id
  #   @return [Integer]
  id: {
    class: :integer,
    identifier: :primary,
    readonly: true
  },

  # @!attribute name
  #   @return [String]
  name: {
    class: :string,
    identifier: true
  },

  # @!attribute criteria
  #   @return [Array<Jamf::Criterion>]
  criteria: {
    class: Jamf::Criterion,
    multi: true,
    required: true
  },

  # @!attribute displayFields
  #   @return [Array<String>]
  displayFields: {
    class: :string,
    multi: true
  },

  # @!attribute site
  #   @return [Jamf::Site::Reference]
  site: {
    class: Jamf::Site::Reference
  }

}.freeze

Instance Attribute Summary

• #criteria ⇒ Array<Jamf::Criterion>
• #displayFields ⇒ Array<String>
• #id ⇒ Integer readonly
• #name ⇒ String
• #site ⇒ Jamf::Site::Reference

Class Method Summary

• .new(*args, &block) ⇒ Object extended from Abstract

  when any extended class or subclass of an extended class is instntiated check that it isn’t in the abstract list.

Constructor Details

This class inherits a constructor from Jamf::JSONObject

Instance Attribute Details

#criteria ⇒ Array<Jamf::Criterion>

Returns:

• (Array<Jamf::Criterion>)

# File 'lib/jamf/api/abstract_classes/advanced_search.rb', line 61

#displayFields ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/jamf/api/abstract_classes/advanced_search.rb', line 69

#id ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/abstract_classes/advanced_search.rb', line 46

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/abstract_classes/advanced_search.rb', line 54

#site ⇒ Jamf::Site::Reference

Returns:

• (Jamf::Site::Reference)

# File 'lib/jamf/api/abstract_classes/advanced_search.rb', line 76

Class Method Details

.new(*args, &block) ⇒ Object Originally defined in module Abstract

when any extended class or subclass of an extended class is instntiated check that it isn’t in the abstract list.

Raises:

• (Jamf::UnsupportedError)