17
17
package com .google .api .services .cloudchannel .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 Cloud Channel API. For a detailed explanation see:
@@ -39,18 +39,18 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
39
39
/**
40
40
* Unstructured address lines describing the lower levels of an address. Because values in
41
41
* address_lines do not have type information and may sometimes contain multiple values in a
42
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
43
- * address lines should be "envelope order" for the country/region of the address. In places where
44
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
45
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
46
- * of an address can be selected based on the language. The minimum permitted structural
47
- * representation of an address consists of a region_code with all remaining information placed in
48
- * the address_lines. It would be possible to format such an address very approximately without
49
- * geocoding, but no semantic reasoning could be made about any of the address components until it
50
- * was at least partially resolved. Creating an address only containing a region_code and
51
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
52
- * addresses (as opposed to guessing which parts of the address should be localities or
53
- * administrative areas).
42
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
43
+ * order of address lines should be "envelope order" for the country/region of the address. In
44
+ * places where this can vary (For example Japan), address_language is used to make it explicit
45
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
46
+ * way, the most specific line of an address can be selected based on the language. The minimum
47
+ * permitted structural representation of an address consists of a region_code with all remaining
48
+ * information placed in the address_lines. It would be possible to format such an address very
49
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
50
+ * address components until it was at least partially resolved. Creating an address only
51
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
52
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
53
+ * localities or administrative areas).
54
54
* The value may be {@code null}.
55
55
*/
56
56
@ com .google .api .client .util .Key
@@ -59,9 +59,9 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
59
59
/**
60
60
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
61
61
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
62
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
63
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
64
- * Switzerland this should be left unpopulated.
62
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
63
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
64
+ * example in Switzerland this should be left unpopulated.
65
65
* The value may be {@code null}.
66
66
*/
67
67
@ com .google .api .client .util .Key
@@ -99,7 +99,7 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
99
99
/**
100
100
* Optional. Postal code of the address. Not all countries use or require postal codes to be
101
101
* present, but where they are used, they may trigger additional validation with other parts of
102
- * the address (e.g. state/zip validation in the U.S.A.).
102
+ * the address (For example state/zip validation in the U.S.A.).
103
103
* The value may be {@code null}.
104
104
*/
105
105
@ com .google .api .client .util .Key
@@ -133,9 +133,9 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
133
133
134
134
/**
135
135
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
136
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
137
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
138
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
136
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
137
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
138
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
139
139
* The value may be {@code null}.
140
140
*/
141
141
@ com .google .api .client .util .Key
@@ -152,18 +152,18 @@ public final class GoogleTypePostalAddress extends com.google.api.client.json.Ge
152
152
/**
153
153
* Unstructured address lines describing the lower levels of an address. Because values in
154
154
* address_lines do not have type information and may sometimes contain multiple values in a
155
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
156
- * address lines should be "envelope order" for the country/region of the address. In places where
157
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
158
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
159
- * of an address can be selected based on the language. The minimum permitted structural
160
- * representation of an address consists of a region_code with all remaining information placed in
161
- * the address_lines. It would be possible to format such an address very approximately without
162
- * geocoding, but no semantic reasoning could be made about any of the address components until it
163
- * was at least partially resolved. Creating an address only containing a region_code and
164
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
165
- * addresses (as opposed to guessing which parts of the address should be localities or
166
- * administrative areas).
155
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
156
+ * order of address lines should be "envelope order" for the country/region of the address. In
157
+ * places where this can vary (For example Japan), address_language is used to make it explicit
158
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
159
+ * way, the most specific line of an address can be selected based on the language. The minimum
160
+ * permitted structural representation of an address consists of a region_code with all remaining
161
+ * information placed in the address_lines. It would be possible to format such an address very
162
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
163
+ * address components until it was at least partially resolved. Creating an address only
164
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
165
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
166
+ * localities or administrative areas).
167
167
* @return value or {@code null} for none
168
168
*/
169
169
public java .util .List <java .lang .String > getAddressLines () {
@@ -173,18 +173,18 @@ public java.util.List<java.lang.String> getAddressLines() {
173
173
/**
174
174
* Unstructured address lines describing the lower levels of an address. Because values in
175
175
* address_lines do not have type information and may sometimes contain multiple values in a
176
- * single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of
177
- * address lines should be "envelope order" for the country/region of the address. In places where
178
- * this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-
179
- * to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line
180
- * of an address can be selected based on the language. The minimum permitted structural
181
- * representation of an address consists of a region_code with all remaining information placed in
182
- * the address_lines. It would be possible to format such an address very approximately without
183
- * geocoding, but no semantic reasoning could be made about any of the address components until it
184
- * was at least partially resolved. Creating an address only containing a region_code and
185
- * address_lines, and then geocoding is the recommended way to handle completely unstructured
186
- * addresses (as opposed to guessing which parts of the address should be localities or
187
- * administrative areas).
176
+ * single field (For example "Austin, TX"), it is important that the line order is clear. The
177
+ * order of address lines should be "envelope order" for the country/region of the address. In
178
+ * places where this can vary (For example Japan), address_language is used to make it explicit
179
+ * (For example "ja" for large- to-small ordering and "ja-Latn" or "en" for small-to-large). This
180
+ * way, the most specific line of an address can be selected based on the language. The minimum
181
+ * permitted structural representation of an address consists of a region_code with all remaining
182
+ * information placed in the address_lines. It would be possible to format such an address very
183
+ * approximately without geocoding, but no semantic reasoning could be made about any of the
184
+ * address components until it was at least partially resolved. Creating an address only
185
+ * containing a region_code and address_lines, and then geocoding is the recommended way to handle
186
+ * completely unstructured addresses (as opposed to guessing which parts of the address should be
187
+ * localities or administrative areas).
188
188
* @param addressLines addressLines or {@code null} for none
189
189
*/
190
190
public GoogleTypePostalAddress setAddressLines (java .util .List <java .lang .String > addressLines ) {
@@ -195,9 +195,9 @@ public GoogleTypePostalAddress setAddressLines(java.util.List<java.lang.String>
195
195
/**
196
196
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
197
197
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
198
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
199
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
200
- * Switzerland this should be left unpopulated.
198
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
199
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
200
+ * example in Switzerland this should be left unpopulated.
201
201
* @return value or {@code null} for none
202
202
*/
203
203
public java .lang .String getAdministrativeArea () {
@@ -207,9 +207,9 @@ public java.lang.String getAdministrativeArea() {
207
207
/**
208
208
* Optional. Highest administrative subdivision which is used for postal addresses of a country or
209
209
* region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically,
210
- * for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not
211
- * "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in
212
- * Switzerland this should be left unpopulated.
210
+ * for Spain this is the province and not the autonomous community (For example "Barcelona" and
211
+ * not "Catalonia"). Many countries don't use an administrative area in postal addresses. For
212
+ * example in Switzerland this should be left unpopulated.
213
213
* @param administrativeArea administrativeArea or {@code null} for none
214
214
*/
215
215
public GoogleTypePostalAddress setAdministrativeArea (java .lang .String administrativeArea ) {
@@ -287,7 +287,7 @@ public GoogleTypePostalAddress setOrganization(java.lang.String organization) {
287
287
/**
288
288
* Optional. Postal code of the address. Not all countries use or require postal codes to be
289
289
* present, but where they are used, they may trigger additional validation with other parts of
290
- * the address (e.g. state/zip validation in the U.S.A.).
290
+ * the address (For example state/zip validation in the U.S.A.).
291
291
* @return value or {@code null} for none
292
292
*/
293
293
public java .lang .String getPostalCode () {
@@ -297,7 +297,7 @@ public java.lang.String getPostalCode() {
297
297
/**
298
298
* Optional. Postal code of the address. Not all countries use or require postal codes to be
299
299
* present, but where they are used, they may trigger additional validation with other parts of
300
- * the address (e.g. state/zip validation in the U.S.A.).
300
+ * the address (For example state/zip validation in the U.S.A.).
301
301
* @param postalCode postalCode or {@code null} for none
302
302
*/
303
303
public GoogleTypePostalAddress setPostalCode (java .lang .String postalCode ) {
@@ -368,9 +368,9 @@ public GoogleTypePostalAddress setRevision(java.lang.Integer revision) {
368
368
369
369
/**
370
370
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
371
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
372
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
373
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
371
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
372
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
373
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
374
374
* @return value or {@code null} for none
375
375
*/
376
376
public java .lang .String getSortingCode () {
@@ -379,9 +379,9 @@ public java.lang.String getSortingCode() {
379
379
380
380
/**
381
381
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where
382
- * it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g.
383
- * "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area
384
- * indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
382
+ * it is used, the value is either a string like "CEDEX", optionally followed by a number (For
383
+ * example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery
384
+ * area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
385
385
* @param sortingCode sortingCode or {@code null} for none
386
386
*/
387
387
public GoogleTypePostalAddress setSortingCode (java .lang .String sortingCode ) {
0 commit comments