Class: Azure::CognitiveServices::LocalSearch::V1_0::Models::Response

Inherits:
Identifiable show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb

Overview

Defines a response. All schemas that return at the root of the response must inherit from this object.

Direct Known Subclasses

Answer, ErrorResponse, SearchResponse, Thing

Instance Attribute Summary collapse

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Response

Returns a new instance of Response.



17
18
19
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 17

def initialize
  @_type = "Response"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



21
22
23
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 21

def _type
  @_type
end

#adaptive_card ⇒ String

Returns:

  • (String) 


39
40
41
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 39

def adaptive_card
  @adaptive_card
end

#immediate_action ⇒ Array<Action>

Returns:



33
34
35
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 33

def immediate_action
  @immediate_action
end

#potential_action ⇒ Array<Action>

Returns:



30
31
32
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 30

def potential_action
  @potential_action
end

#preferred_clickthrough_url ⇒ String

Returns:

  • (String) 


36
37
38
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 36

def preferred_clickthrough_url
  @preferred_clickthrough_url
end

#read_link ⇒ String

Returns The URL that returns this resource.

Returns:

  • (String) —

    The URL that returns this resource.



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 24

def read_link
  @read_link
end

#web_search_url ⇒ String

Returns The URL to Bing’s search result for this item.

Returns:

  • (String) —

    The URL to Bing’s search result for this item.



27
28
29
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 27

def web_search_url
  @web_search_url
end

Class Method Details

.mapper ⇒ Object

Mapper for Response class as Ruby Hash. This will be used for serialization/deserialization.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/response.rb', line 46

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Response',
    type: {
      name: 'Composite',
      class_name: 'Response',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        read_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readLink',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        potential_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'potentialAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        immediate_action: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'immediateAction',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Action'
                }
            }
          }
        },
        preferred_clickthrough_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'preferredClickthroughUrl',
          type: {
            name: 'String'
          }
        },
        adaptive_card: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'adaptiveCard',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end