Class: Azure::CognitiveServices::LocalSearch::V1_0::Models::PostalAddress

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

Overview

Defines a postal address.

Instance Attribute Summary collapse

Attributes inherited from Thing

#entity_presentation_info, #name, #url

Attributes inherited from Response

#adaptive_card, #immediate_action, #potential_action, #preferred_clickthrough_url, #read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PostalAddress

Returns a new instance of PostalAddress.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 16

def initialize
  @_type = "PostalAddress"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 20

def _type
  @_type
end

#address_country ⇒ String

located. This could be the two-letter ISO code. For example, US, or the full name, United States.

Returns:

  • (String) —

    The country/region where the street address is



47
48
49
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 47

def address_country
  @address_country
end

#address_locality ⇒ String

example, Seattle.

Returns:

  • (String) —

    The city where the street address is located. For



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

def address_locality
  @address_locality
end

#address_region ⇒ String

located. This could be the two-letter code. For example, WA, or the full name , Washington.

Returns:

  • (String) —

    The state or province code where the street address is



35
36
37
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 35

def address_region
  @address_region
end

#address_region_abbreviation ⇒ String

Returns Region Abbreviation. For example, WA.

Returns:

  • (String) —

    Region Abbreviation. For example, WA.



58
59
60
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 58

def address_region_abbreviation
  @address_region_abbreviation
end

#address_subregion ⇒ String

Returns:

  • (String) 


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

def address_subregion
  @address_subregion
end

#country_iso ⇒ String

US.

Returns:

  • (String) —

    The two letter ISO code of this country. For example,



51
52
53
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 51

def country_iso
  @country_iso
end

#formatting_rule_id ⇒ String

Returns:

  • (String) 


71
72
73
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 71

def formatting_rule_id
  @formatting_rule_id
end

#house_number ⇒ String

Returns:

  • (String) 


65
66
67
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 65

def house_number
  @house_number
end

#neighborhood ⇒ String

For example, Westlake.

Returns:

  • (String) —

    The neighborhood where the street address is located.



55
56
57
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 55

def neighborhood
  @neighborhood
end

#post_office_box_number ⇒ String

Returns:

  • (String) 


42
43
44
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 42

def post_office_box_number
  @post_office_box_number
end

#postal_code ⇒ String

is located. For example, 98052.

Returns:

  • (String) —

    The zip code or postal code where the street address



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

def postal_code
  @postal_code
end

#street_address ⇒ String

Returns:

  • (String) 


23
24
25
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 23

def street_address
  @street_address
end

#street_name ⇒ String

Returns:

  • (String) 


68
69
70
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 68

def street_name
  @street_name
end

#text ⇒ String

N, Bellevue, WA 98052.

Returns:

  • (String) —

    The complete address. For example, 2100 Westlake Ave



62
63
64
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 62

def text
  @text
end

Class Method Details

.mapper ⇒ Object

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



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/1.0/generated/azure_cognitiveservices_localsearch/models/postal_address.rb', line 78

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'PostalAddress',
    type: {
      name: 'Composite',
      class_name: 'PostalAddress',
      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'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'url',
          type: {
            name: 'String'
          }
        },
        entity_presentation_info: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'entityPresentationInfo',
          type: {
            name: 'Composite',
            polymorphic_discriminator: '_type',
            uber_parent: 'EntitiesEntityPresentationInfo',
            class_name: 'EntitiesEntityPresentationInfo'
          }
        },
        street_address: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'streetAddress',
          type: {
            name: 'String'
          }
        },
        address_locality: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressLocality',
          type: {
            name: 'String'
          }
        },
        address_subregion: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressSubregion',
          type: {
            name: 'String'
          }
        },
        address_region: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressRegion',
          type: {
            name: 'String'
          }
        },
        postal_code: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'postalCode',
          type: {
            name: 'String'
          }
        },
        post_office_box_number: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'postOfficeBoxNumber',
          type: {
            name: 'String'
          }
        },
        address_country: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressCountry',
          type: {
            name: 'String'
          }
        },
        country_iso: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'countryIso',
          type: {
            name: 'String'
          }
        },
        neighborhood: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'neighborhood',
          type: {
            name: 'String'
          }
        },
        address_region_abbreviation: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'addressRegionAbbreviation',
          type: {
            name: 'String'
          }
        },
        text: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        house_number: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'houseNumber',
          type: {
            name: 'String'
          }
        },
        street_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'streetName',
          type: {
            name: 'String'
          }
        },
        formatting_rule_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'formattingRuleId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end