1 // Code generated by protoc-gen-go. DO NOT EDIT.
2 // source: google/type/postal_address.proto
5 Package postaladdress is a generated protocol buffer package.
7 It is generated from these files:
8 google/type/postal_address.proto
10 It has these top-level messages:
15 import proto "github.com/golang/protobuf/proto"
19 // Reference imports to suppress errors if they are not otherwise used.
24 // This is a compile-time assertion to ensure that this generated file
25 // is compatible with the proto package it is being compiled against.
26 // A compilation error at this line likely means your copy of the
27 // proto package needs to be updated.
28 const _ = proto.ProtoPackageIsVersion2 // please upgrade the proto package
30 // Represents a postal address, e.g. for postal delivery or payments addresses.
31 // Given a postal address, a postal service can deliver items to a premise, P.O.
33 // It is not intended to model geographical locations (roads, towns,
36 // In typical usage an address would be created via user input or from importing
37 // existing data, depending on the type of process.
39 // Advice on address input / editing:
40 // - Use an i18n-ready address widget such as
41 // https://github.com/googlei18n/libaddressinput)
42 // - Users should not be presented with UI elements for input or editing of
43 // fields outside countries where that field is used.
45 // For more guidance on how to use this schema, please see:
46 // https://support.google.com/business/answer/6397478
47 type PostalAddress struct {
48 // The schema revision of the `PostalAddress`.
49 // All new revisions **must** be backward compatible with old revisions.
50 Revision int32 `protobuf:"varint,1,opt,name=revision" json:"revision,omitempty"`
51 // Required. CLDR region code of the country/region of the address. This
52 // is never inferred and it is up to the user to ensure the value is
53 // correct. See http://cldr.unicode.org/ and
54 // http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
55 // for details. Example: "CH" for Switzerland.
56 RegionCode string `protobuf:"bytes,2,opt,name=region_code,json=regionCode" json:"region_code,omitempty"`
57 // Optional. BCP-47 language code of the contents of this address (if
58 // known). This is often the UI language of the input form or is expected
59 // to match one of the languages used in the address' country/region, or their
60 // transliterated equivalents.
61 // This can affect formatting in certain countries, but is not critical
62 // to the correctness of the data and will never affect any validation or
63 // other non-formatting related operations.
65 // If this value is not known, it should be omitted (rather than specifying a
66 // possibly incorrect default).
68 // Examples: "zh-Hant", "ja", "ja-Latn", "en".
69 LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode" json:"language_code,omitempty"`
70 // Optional. Postal code of the address. Not all countries use or require
71 // postal codes to be present, but where they are used, they may trigger
72 // additional validation with other parts of the address (e.g. state/zip
73 // validation in the U.S.A.).
74 PostalCode string `protobuf:"bytes,4,opt,name=postal_code,json=postalCode" json:"postal_code,omitempty"`
75 // Optional. Additional, country-specific, sorting code. This is not used
76 // in most regions. Where it is used, the value is either a string like
77 // "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
78 // alone, representing the "sector code" (Jamaica), "delivery area indicator"
79 // (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
80 SortingCode string `protobuf:"bytes,5,opt,name=sorting_code,json=sortingCode" json:"sorting_code,omitempty"`
81 // Optional. Highest administrative subdivision which is used for postal
82 // addresses of a country or region.
83 // For example, this can be a state, a province, an oblast, or a prefecture.
84 // Specifically, for Spain this is the province and not the autonomous
85 // community (e.g. "Barcelona" and not "Catalonia").
86 // Many countries don't use an administrative area in postal addresses. E.g.
87 // in Switzerland this should be left unpopulated.
88 AdministrativeArea string `protobuf:"bytes,6,opt,name=administrative_area,json=administrativeArea" json:"administrative_area,omitempty"`
89 // Optional. Generally refers to the city/town portion of the address.
90 // Examples: US city, IT comune, UK post town.
91 // In regions of the world where localities are not well defined or do not fit
92 // into this structure well, leave locality empty and use address_lines.
93 Locality string `protobuf:"bytes,7,opt,name=locality" json:"locality,omitempty"`
94 // Optional. Sublocality of the address.
95 // For example, this can be neighborhoods, boroughs, districts.
96 Sublocality string `protobuf:"bytes,8,opt,name=sublocality" json:"sublocality,omitempty"`
97 // Unstructured address lines describing the lower levels of an address.
99 // Because values in address_lines do not have type information and may
100 // sometimes contain multiple values in a single field (e.g.
101 // "Austin, TX"), it is important that the line order is clear. The order of
102 // address lines should be "envelope order" for the country/region of the
103 // address. In places where this can vary (e.g. Japan), address_language is
104 // used to make it explicit (e.g. "ja" for large-to-small ordering and
105 // "ja-Latn" or "en" for small-to-large). This way, the most specific line of
106 // an address can be selected based on the language.
108 // The minimum permitted structural representation of an address consists
109 // of a region_code with all remaining information placed in the
110 // address_lines. It would be possible to format such an address very
111 // approximately without geocoding, but no semantic reasoning could be
112 // made about any of the address components until it was at least
113 // partially resolved.
115 // Creating an address only containing a region_code and address_lines, and
116 // then geocoding is the recommended way to handle completely unstructured
117 // addresses (as opposed to guessing which parts of the address should be
118 // localities or administrative areas).
119 AddressLines []string `protobuf:"bytes,9,rep,name=address_lines,json=addressLines" json:"address_lines,omitempty"`
120 // Optional. The recipient at the address.
121 // This field may, under certain circumstances, contain multiline information.
122 // For example, it might contain "care of" information.
123 Recipients []string `protobuf:"bytes,10,rep,name=recipients" json:"recipients,omitempty"`
124 // Optional. The name of the organization at the address.
125 Organization string `protobuf:"bytes,11,opt,name=organization" json:"organization,omitempty"`
128 func (m *PostalAddress) Reset() { *m = PostalAddress{} }
129 func (m *PostalAddress) String() string { return proto.CompactTextString(m) }
130 func (*PostalAddress) ProtoMessage() {}
131 func (*PostalAddress) Descriptor() ([]byte, []int) { return fileDescriptor0, []int{0} }
133 func (m *PostalAddress) GetRevision() int32 {
140 func (m *PostalAddress) GetRegionCode() string {
147 func (m *PostalAddress) GetLanguageCode() string {
149 return m.LanguageCode
154 func (m *PostalAddress) GetPostalCode() string {
161 func (m *PostalAddress) GetSortingCode() string {
168 func (m *PostalAddress) GetAdministrativeArea() string {
170 return m.AdministrativeArea
175 func (m *PostalAddress) GetLocality() string {
182 func (m *PostalAddress) GetSublocality() string {
189 func (m *PostalAddress) GetAddressLines() []string {
191 return m.AddressLines
196 func (m *PostalAddress) GetRecipients() []string {
203 func (m *PostalAddress) GetOrganization() string {
205 return m.Organization
211 proto.RegisterType((*PostalAddress)(nil), "google.type.PostalAddress")
214 func init() { proto.RegisterFile("google/type/postal_address.proto", fileDescriptor0) }
216 var fileDescriptor0 = []byte{
217 // 338 bytes of a gzipped FileDescriptorProto
218 0x1f, 0x8b, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0xff, 0x54, 0x92, 0x31, 0x6f, 0xea, 0x30,
219 0x10, 0xc7, 0x15, 0xf2, 0xe0, 0xc1, 0x05, 0xf4, 0x24, 0xbf, 0x25, 0xea, 0x50, 0x52, 0xba, 0x30,
220 0x25, 0x43, 0xc7, 0x4e, 0x50, 0xa9, 0x5d, 0x3a, 0x44, 0xa8, 0x53, 0x97, 0xc8, 0x24, 0x27, 0xcb,
221 0x52, 0xf0, 0x45, 0xb6, 0x41, 0xa2, 0xdf, 0xa1, 0x5f, 0xa2, 0x9f, 0xb4, 0xb2, 0x9d, 0xd2, 0x30,
222 0xde, 0xef, 0x7e, 0x49, 0xee, 0xee, 0x1f, 0xc8, 0x04, 0x91, 0x68, 0xb1, 0xb0, 0xe7, 0x0e, 0x8b,
223 0x8e, 0x8c, 0xe5, 0x6d, 0xc5, 0x9b, 0x46, 0xa3, 0x31, 0x79, 0xa7, 0xc9, 0x12, 0x4b, 0x82, 0x91,
224 0x3b, 0x63, 0xf5, 0x19, 0xc3, 0xa2, 0xf4, 0xd6, 0x26, 0x48, 0xec, 0x06, 0xa6, 0x1a, 0x4f, 0xd2,
225 0x48, 0x52, 0x69, 0x94, 0x45, 0xeb, 0xf1, 0xee, 0x52, 0xb3, 0x25, 0x24, 0x1a, 0x85, 0x24, 0x55,
226 0xd5, 0xd4, 0x60, 0x3a, 0xca, 0xa2, 0xf5, 0x6c, 0x07, 0x01, 0x3d, 0x51, 0x83, 0xec, 0x1e, 0x16,
227 0x2d, 0x57, 0xe2, 0xc8, 0x05, 0x06, 0x25, 0xf6, 0xca, 0xfc, 0x07, 0x7a, 0x69, 0x09, 0x49, 0x3f,
228 0x98, 0x57, 0xfe, 0x84, 0xb7, 0x04, 0xe4, 0x85, 0x3b, 0x98, 0x1b, 0xd2, 0x56, 0x2a, 0x11, 0x8c,
229 0xb1, 0x37, 0x92, 0x9e, 0x79, 0xa5, 0x80, 0xff, 0xbc, 0x39, 0x48, 0x25, 0x8d, 0xd5, 0xdc, 0xca,
230 0x13, 0x56, 0x5c, 0x23, 0x4f, 0x27, 0xde, 0x64, 0xd7, 0xad, 0x8d, 0x46, 0xee, 0xd6, 0x6a, 0xa9,
231 0xe6, 0xad, 0xb4, 0xe7, 0xf4, 0xaf, 0xb7, 0x2e, 0x35, 0xcb, 0x20, 0x31, 0xc7, 0xfd, 0xa5, 0x3d,
232 0xed, 0x3f, 0xf7, 0x8b, 0xdc, 0x5e, 0xfd, 0x11, 0xab, 0x56, 0x2a, 0x34, 0xe9, 0x2c, 0x8b, 0xdd,
233 0x5e, 0x3d, 0x7c, 0x75, 0x8c, 0xdd, 0x02, 0x68, 0xac, 0x65, 0x27, 0x51, 0x59, 0x93, 0x82, 0x37,
234 0x06, 0x84, 0xad, 0x60, 0x4e, 0x5a, 0x70, 0x25, 0x3f, 0xb8, 0x75, 0xd7, 0x4d, 0xc2, 0x6d, 0x86,
235 0x6c, 0x7b, 0x84, 0x7f, 0x35, 0x1d, 0xf2, 0x41, 0x44, 0x5b, 0x76, 0x95, 0x4f, 0xe9, 0x32, 0x2c,
236 0xa3, 0xf7, 0xe7, 0x5e, 0x11, 0xe4, 0x6e, 0x9b, 0x93, 0x16, 0x85, 0x40, 0xe5, 0x13, 0x2e, 0x42,
237 0x8b, 0x77, 0xd2, 0x0c, 0x7f, 0x83, 0x7e, 0xd6, 0xc7, 0xab, 0xea, 0x6b, 0x14, 0xbf, 0xbc, 0x95,
238 0xfb, 0x89, 0x7f, 0xf0, 0xe1, 0x3b, 0x00, 0x00, 0xff, 0xff, 0xda, 0x86, 0xd3, 0x22, 0x3e, 0x02,