Class: Verizon::QueryTargetRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/query_target_request.rb

Overview

Search for targets by property values.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(accountidentifier = SKIP, selection = SKIP, resourceidentifier = SKIP) ⇒ QueryTargetRequest

Returns a new instance of QueryTargetRequest.



53
54
55
56
57
58
 
# File 'lib/verizon/models/query_target_request.rb', line 53

def initialize(accountidentifier = SKIP, selection = SKIP,
               resourceidentifier = SKIP)
  @accountidentifier = accountidentifier unless accountidentifier == SKIP
  @selection = selection unless selection == SKIP
  @resourceidentifier = resourceidentifier unless resourceidentifier == SKIP
end

Instance Attribute Details

#accountidentifier ⇒ AccountIdentifier

The ID of the authenticating billing account, in the format ‘“billingaccountid”:“1234567890-12345”`.

Returns:



15
16
17
 
# File 'lib/verizon/models/query_target_request.rb', line 15

def accountidentifier
  @accountidentifier
end

#resourceidentifier ⇒ ResourceIdentifier

The ID of the target to delete, in the format “dd1682d3-2d80-cefc-f3ee-25154800beff”.

Returns:



28
29
30
 
# File 'lib/verizon/models/query_target_request.rb', line 28

def resourceidentifier
  @resourceidentifier
end

#selection ⇒ Hash[String, String]

A comma-separated list of properties and comparator values to match against subscriptions in the ThingSpace account. See Working with Query Filters for more information. If the request does not include ‘$selection`, the response will include all subscriptions to which the requesting user has access.

Returns:

  • (Hash[String, String]) 


23
24
25
 
# File 'lib/verizon/models/query_target_request.rb', line 23

def selection
  @selection
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/verizon/models/query_target_request.rb', line 61

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  accountidentifier = AccountIdentifier.from_hash(hash['accountidentifier']) if
    hash['accountidentifier']
  selection = hash.key?('$selection') ? hash['$selection'] : SKIP
  resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
    hash['resourceidentifier']

  # Create object from extracted values.
  QueryTargetRequest.new(accountidentifier,
                         selection,
                         resourceidentifier)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
 
# File 'lib/verizon/models/query_target_request.rb', line 31

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['accountidentifier'] = 'accountidentifier'
  @_hash['selection'] = '$selection'
  @_hash['resourceidentifier'] = 'resourceidentifier'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/verizon/models/query_target_request.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



40
41
42
43
44
45
46
 
# File 'lib/verizon/models/query_target_request.rb', line 40

def self.optionals
  %w[
    accountidentifier
    selection
    resourceidentifier
  ]
end