17
17
package com .google .api .services .addressvalidation .v1 .model ;
18
18
19
19
/**
20
- * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal
21
- * address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended
22
- * to model geographical locations (roads, towns, mountains). In typical usage an address would be
23
- * created via user input or from importing existing data, depending on the type of process. Advice
24
- * on address input / editing: - Use an internationalization-ready address widget such as
20
+ * Represents a postal address. For example for postal delivery or payments addresses. Given a
21
+ * postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not
22
+ * intended to model geographical locations (roads, towns, mountains). In typical usage an address
23
+ * would be created by user input or from importing existing data, depending on the type of process.
24
+ * Advice on address input / editing: - Use an internationalization-ready address widget such as
25
25
* https://github.com/google/libaddressinput) - Users should not be presented with UI elements for
26
26
* input or editing of fields outside countries where that field is used. For more guidance on how
27
- * to use this schema, please see: https://support.google.com/business/answer/6397478
27
+ * to use this schema, see: https://support.google.com/business/answer/6397478
28
28
*
29
29
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
30
30
* transmitted over HTTP when working with the Address Validation API. For a detailed explanation
@@ -40,18 +40,18 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
40
40
/**
41
41
* Unstructured address lines describing the lower levels of an address. Because values in
42
42
* address_lines do not have type information and may sometimes contain multiple values in a
43
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
44
- * address lines should be "envelope order" for the country/region of the address. In places where
45
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
46
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
47
- * of an address can be selected based on the language. The minimum permitted structural
48
- * representation of an address consists of a region_code with all remaining information placed in
49
- * the address_lines. It would be possible to format such an address very approximately without
50
- * geocoding, but no semantic reasoning could be made about any of the address components until it
51
- * was at least partially resolved. Creating an address only containing a region_code and
52
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
53
- * addresses (as opposed to guessing which parts of the address should be localities or
54
- * administrative areas).
43
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
44
+ * order of address lines should be "envelope order" for the country/region of the address. In
45
+ * places where this can vary (For example Japan), address_language is used to make it explicit
46
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
47
+ * way, the most specific line of an address can be selected based on the language. The minimum
48
+ * permitted structural representation of an address consists of a region_code with all remaining
49
+ * information placed in the address_lines. It would be possible to format such an address very
50
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
51
+ * address components until it was at least partially resolved. Creating an address only
52
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
53
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
54
+ * localities or administrative areas).
55
55
* The value may be {@code null}.
56
56
*/
57
57
@ com .google .api .client .util .Key
@@ -60,9 +60,9 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
60
60
/**
61
61
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
62
62
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
63
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
64
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
65
- * Switzerland this should be left unpopulated.
63
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
64
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
65
+ * example in Switzerland this should be left unpopulated.
66
66
* The value may be {@code null}.
67
67
*/
68
68
@ com .google .api .client .util .Key
@@ -100,7 +100,7 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
100
100
/**
101
101
* Optional. Postal code of the address. Not all countries use or require postal codes to be
102
102
* present, but where they are used, they may trigger additional validation with other parts of
103
- * the address (e.g. state/zip validation in the U.S.A.).
103
+ * the address (For example state/zip validation in the U.S.A.).
104
104
* The value may be {@code null}.
105
105
*/
106
106
@ com .google .api .client .util .Key
@@ -134,9 +134,9 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
134
134
135
135
/**
136
136
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
137
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
138
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
139
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
137
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
138
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
139
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
140
140
* The value may be {@code null}.
141
141
*/
142
142
@ com .google .api .client .util .Key
@@ -153,18 +153,18 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
153
153
/**
154
154
* Unstructured address lines describing the lower levels of an address. Because values in
155
155
* address_lines do not have type information and may sometimes contain multiple values in a
156
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
157
- * address lines should be "envelope order" for the country/region of the address. In places where
158
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
159
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
160
- * of an address can be selected based on the language. The minimum permitted structural
161
- * representation of an address consists of a region_code with all remaining information placed in
162
- * the address_lines. It would be possible to format such an address very approximately without
163
- * geocoding, but no semantic reasoning could be made about any of the address components until it
164
- * was at least partially resolved. Creating an address only containing a region_code and
165
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
166
- * addresses (as opposed to guessing which parts of the address should be localities or
167
- * administrative areas).
156
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
157
+ * order of address lines should be "envelope order" for the country/region of the address. In
158
+ * places where this can vary (For example Japan), address_language is used to make it explicit
159
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
160
+ * way, the most specific line of an address can be selected based on the language. The minimum
161
+ * permitted structural representation of an address consists of a region_code with all remaining
162
+ * information placed in the address_lines. It would be possible to format such an address very
163
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
164
+ * address components until it was at least partially resolved. Creating an address only
165
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
166
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
167
+ * localities or administrative areas).
168
168
* @return value or {@code null} for none
169
169
*/
170
170
public java .util .List <java .lang .String > getAddressLines () {
@@ -174,18 +174,18 @@ public java.util.List<java.lang.String> getAddressLines() {
174
174
/**
175
175
* Unstructured address lines describing the lower levels of an address. Because values in
176
176
* address_lines do not have type information and may sometimes contain multiple values in a
177
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
178
- * address lines should be "envelope order" for the country/region of the address. In places where
179
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
180
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
181
- * of an address can be selected based on the language. The minimum permitted structural
182
- * representation of an address consists of a region_code with all remaining information placed in
183
- * the address_lines. It would be possible to format such an address very approximately without
184
- * geocoding, but no semantic reasoning could be made about any of the address components until it
185
- * was at least partially resolved. Creating an address only containing a region_code and
186
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
187
- * addresses (as opposed to guessing which parts of the address should be localities or
188
- * administrative areas).
177
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
178
+ * order of address lines should be "envelope order" for the country/region of the address. In
179
+ * places where this can vary (For example Japan), address_language is used to make it explicit
180
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
181
+ * way, the most specific line of an address can be selected based on the language. The minimum
182
+ * permitted structural representation of an address consists of a region_code with all remaining
183
+ * information placed in the address_lines. It would be possible to format such an address very
184
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
185
+ * address components until it was at least partially resolved. Creating an address only
186
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
187
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
188
+ * localities or administrative areas).
189
189
* @param addressLines addressLines or {@code null} for none
190
190
*/
191
191
public GoogleTypePostalAddress setAddressLines (java .util .List <java .lang .String > addressLines ) {
@@ -196,9 +196,9 @@ public GoogleTypePostalAddress setAddressLines(java.util.List<java.lang.String>
196
196
/**
197
197
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
198
198
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
199
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
200
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
201
- * Switzerland this should be left unpopulated.
199
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
200
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
201
+ * example in Switzerland this should be left unpopulated.
202
202
* @return value or {@code null} for none
203
203
*/
204
204
public java .lang .String getAdministrativeArea () {
@@ -208,9 +208,9 @@ public java.lang.String getAdministrativeArea() {
208
208
/**
209
209
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
210
210
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
211
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
212
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
213
- * Switzerland this should be left unpopulated.
211
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
212
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
213
+ * example in Switzerland this should be left unpopulated.
214
214
* @param administrativeArea administrativeArea or {@code null} for none
215
215
*/
216
216
public GoogleTypePostalAddress setAdministrativeArea (java .lang .String administrativeArea ) {
@@ -288,7 +288,7 @@ public GoogleTypePostalAddress setOrganization(java.lang.String organization) {
288
288
/**
289
289
* Optional. Postal code of the address. Not all countries use or require postal codes to be
290
290
* present, but where they are used, they may trigger additional validation with other parts of
291
- * the address (e.g. state/zip validation in the U.S.A.).
291
+ * the address (For example state/zip validation in the U.S.A.).
292
292
* @return value or {@code null} for none
293
293
*/
294
294
public java .lang .String getPostalCode () {
@@ -298,7 +298,7 @@ public java.lang.String getPostalCode() {
298
298
/**
299
299
* Optional. Postal code of the address. Not all countries use or require postal codes to be
300
300
* present, but where they are used, they may trigger additional validation with other parts of
301
- * the address (e.g. state/zip validation in the U.S.A.).
301
+ * the address (For example state/zip validation in the U.S.A.).
302
302
* @param postalCode postalCode or {@code null} for none
303
303
*/
304
304
public GoogleTypePostalAddress setPostalCode (java .lang .String postalCode ) {
@@ -369,9 +369,9 @@ public GoogleTypePostalAddress setRevision(java.lang.Integer revision) {
369
369
370
370
/**
371
371
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
372
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
373
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
374
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
372
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
373
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
374
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
375
375
* @return value or {@code null} for none
376
376
*/
377
377
public java .lang .String getSortingCode () {
@@ -380,9 +380,9 @@ public java.lang.String getSortingCode() {
380
380
381
381
/**
382
382
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
383
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
384
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
385
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
383
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
384
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
385
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
386
386
* @param sortingCode sortingCode or {@code null} for none
387
387
*/
388
388
public GoogleTypePostalAddress setSortingCode (java .lang .String sortingCode ) {
0 commit comments