google-cloud-channel-v1 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-channel-v1.rb +21 -0
- data/lib/google/cloud/channel/v1.rb +38 -0
- data/lib/google/cloud/channel/v1/channel_partner_links_pb.rb +47 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service.rb +70 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +3498 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/credentials.rb +51 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +570 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/paths.rb +100 -0
- data/lib/google/cloud/channel/v1/common_pb.rb +76 -0
- data/lib/google/cloud/channel/v1/customers_pb.rb +48 -0
- data/lib/google/cloud/channel/v1/entitlements_pb.rb +110 -0
- data/lib/google/cloud/channel/v1/offers_pb.rb +142 -0
- data/lib/google/cloud/channel/v1/operations_pb.rb +38 -0
- data/lib/google/cloud/channel/v1/products_pb.rb +48 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +331 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +680 -0
- data/lib/google/cloud/channel/v1/version.rb +28 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +283 -0
- data/proto_docs/google/cloud/channel/v1/channel_partner_links.rb +92 -0
- data/proto_docs/google/cloud/channel/v1/common.rb +155 -0
- data/proto_docs/google/cloud/channel/v1/customers.rb +111 -0
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +255 -0
- data/proto_docs/google/cloud/channel/v1/offers.rb +344 -0
- data/proto_docs/google/cloud/channel/v1/operations.rb +74 -0
- data/proto_docs/google/cloud/channel/v1/products.rb +98 -0
- data/proto_docs/google/cloud/channel/v1/service.rb +1013 -0
- data/proto_docs/google/longrunning/operations.rb +150 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/protobuf/wrappers.rb +121 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/money.rb +43 -0
- data/proto_docs/google/type/postal_address.rb +135 -0
- metadata +225 -0
@@ -0,0 +1,120 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Protobuf
|
22
|
+
# A Timestamp represents a point in time independent of any time zone or local
|
23
|
+
# calendar, encoded as a count of seconds and fractions of seconds at
|
24
|
+
# nanosecond resolution. The count is relative to an epoch at UTC midnight on
|
25
|
+
# January 1, 1970, in the proleptic Gregorian calendar which extends the
|
26
|
+
# Gregorian calendar backwards to year one.
|
27
|
+
#
|
28
|
+
# All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
|
29
|
+
# second table is needed for interpretation, using a [24-hour linear
|
30
|
+
# smear](https://developers.google.com/time/smear).
|
31
|
+
#
|
32
|
+
# The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
|
33
|
+
# restricting to that range, we ensure that we can convert to and from [RFC
|
34
|
+
# 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
|
35
|
+
#
|
36
|
+
# # Examples
|
37
|
+
#
|
38
|
+
# Example 1: Compute Timestamp from POSIX `time()`.
|
39
|
+
#
|
40
|
+
# Timestamp timestamp;
|
41
|
+
# timestamp.set_seconds(time(NULL));
|
42
|
+
# timestamp.set_nanos(0);
|
43
|
+
#
|
44
|
+
# Example 2: Compute Timestamp from POSIX `gettimeofday()`.
|
45
|
+
#
|
46
|
+
# struct timeval tv;
|
47
|
+
# gettimeofday(&tv, NULL);
|
48
|
+
#
|
49
|
+
# Timestamp timestamp;
|
50
|
+
# timestamp.set_seconds(tv.tv_sec);
|
51
|
+
# timestamp.set_nanos(tv.tv_usec * 1000);
|
52
|
+
#
|
53
|
+
# Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
|
54
|
+
#
|
55
|
+
# FILETIME ft;
|
56
|
+
# GetSystemTimeAsFileTime(&ft);
|
57
|
+
# UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
|
58
|
+
#
|
59
|
+
# // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
|
60
|
+
# // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
|
61
|
+
# Timestamp timestamp;
|
62
|
+
# timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
|
63
|
+
# timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
|
64
|
+
#
|
65
|
+
# Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
|
66
|
+
#
|
67
|
+
# long millis = System.currentTimeMillis();
|
68
|
+
#
|
69
|
+
# Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
|
70
|
+
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
71
|
+
#
|
72
|
+
#
|
73
|
+
# Example 5: Compute Timestamp from current time in Python.
|
74
|
+
#
|
75
|
+
# timestamp = Timestamp()
|
76
|
+
# timestamp.GetCurrentTime()
|
77
|
+
#
|
78
|
+
# # JSON Mapping
|
79
|
+
#
|
80
|
+
# In JSON format, the Timestamp type is encoded as a string in the
|
81
|
+
# [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
|
82
|
+
# format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
|
83
|
+
# where \\{year} is always expressed using four digits while \\{month}, \\{day},
|
84
|
+
# \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
|
85
|
+
# seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
|
86
|
+
# are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
|
87
|
+
# is required. A proto3 JSON serializer should always use UTC (as indicated by
|
88
|
+
# "Z") when printing the Timestamp type and a proto3 JSON parser should be
|
89
|
+
# able to accept both UTC and other timezones (as indicated by an offset).
|
90
|
+
#
|
91
|
+
# For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
|
92
|
+
# 01:30 UTC on January 15, 2017.
|
93
|
+
#
|
94
|
+
# In JavaScript, one can convert a Date object to this format using the
|
95
|
+
# standard
|
96
|
+
# [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
|
97
|
+
# method. In Python, a standard `datetime.datetime` object can be converted
|
98
|
+
# to this format using
|
99
|
+
# [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
|
100
|
+
# the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
|
101
|
+
# the Joda Time's [`ISODateTimeFormat.dateTime()`](
|
102
|
+
# http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
|
103
|
+
# ) to obtain a formatter capable of generating timestamps in this format.
|
104
|
+
# @!attribute [rw] seconds
|
105
|
+
# @return [::Integer]
|
106
|
+
# Represents seconds of UTC time since Unix epoch
|
107
|
+
# 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
|
108
|
+
# 9999-12-31T23:59:59Z inclusive.
|
109
|
+
# @!attribute [rw] nanos
|
110
|
+
# @return [::Integer]
|
111
|
+
# Non-negative fractions of a second at nanosecond resolution. Negative
|
112
|
+
# second values with fractions must still have non-negative nanos values
|
113
|
+
# that count forward in time. Must be from 0 to 999,999,999
|
114
|
+
# inclusive.
|
115
|
+
class Timestamp
|
116
|
+
include ::Google::Protobuf::MessageExts
|
117
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
118
|
+
end
|
119
|
+
end
|
120
|
+
end
|
@@ -0,0 +1,121 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Protobuf
|
22
|
+
# Wrapper message for `double`.
|
23
|
+
#
|
24
|
+
# The JSON representation for `DoubleValue` is JSON number.
|
25
|
+
# @!attribute [rw] value
|
26
|
+
# @return [::Float]
|
27
|
+
# The double value.
|
28
|
+
class DoubleValue
|
29
|
+
include ::Google::Protobuf::MessageExts
|
30
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
31
|
+
end
|
32
|
+
|
33
|
+
# Wrapper message for `float`.
|
34
|
+
#
|
35
|
+
# The JSON representation for `FloatValue` is JSON number.
|
36
|
+
# @!attribute [rw] value
|
37
|
+
# @return [::Float]
|
38
|
+
# The float value.
|
39
|
+
class FloatValue
|
40
|
+
include ::Google::Protobuf::MessageExts
|
41
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
42
|
+
end
|
43
|
+
|
44
|
+
# Wrapper message for `int64`.
|
45
|
+
#
|
46
|
+
# The JSON representation for `Int64Value` is JSON string.
|
47
|
+
# @!attribute [rw] value
|
48
|
+
# @return [::Integer]
|
49
|
+
# The int64 value.
|
50
|
+
class Int64Value
|
51
|
+
include ::Google::Protobuf::MessageExts
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
|
55
|
+
# Wrapper message for `uint64`.
|
56
|
+
#
|
57
|
+
# The JSON representation for `UInt64Value` is JSON string.
|
58
|
+
# @!attribute [rw] value
|
59
|
+
# @return [::Integer]
|
60
|
+
# The uint64 value.
|
61
|
+
class UInt64Value
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
|
66
|
+
# Wrapper message for `int32`.
|
67
|
+
#
|
68
|
+
# The JSON representation for `Int32Value` is JSON number.
|
69
|
+
# @!attribute [rw] value
|
70
|
+
# @return [::Integer]
|
71
|
+
# The int32 value.
|
72
|
+
class Int32Value
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# Wrapper message for `uint32`.
|
78
|
+
#
|
79
|
+
# The JSON representation for `UInt32Value` is JSON number.
|
80
|
+
# @!attribute [rw] value
|
81
|
+
# @return [::Integer]
|
82
|
+
# The uint32 value.
|
83
|
+
class UInt32Value
|
84
|
+
include ::Google::Protobuf::MessageExts
|
85
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
86
|
+
end
|
87
|
+
|
88
|
+
# Wrapper message for `bool`.
|
89
|
+
#
|
90
|
+
# The JSON representation for `BoolValue` is JSON `true` and `false`.
|
91
|
+
# @!attribute [rw] value
|
92
|
+
# @return [::Boolean]
|
93
|
+
# The bool value.
|
94
|
+
class BoolValue
|
95
|
+
include ::Google::Protobuf::MessageExts
|
96
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
97
|
+
end
|
98
|
+
|
99
|
+
# Wrapper message for `string`.
|
100
|
+
#
|
101
|
+
# The JSON representation for `StringValue` is JSON string.
|
102
|
+
# @!attribute [rw] value
|
103
|
+
# @return [::String]
|
104
|
+
# The string value.
|
105
|
+
class StringValue
|
106
|
+
include ::Google::Protobuf::MessageExts
|
107
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
108
|
+
end
|
109
|
+
|
110
|
+
# Wrapper message for `bytes`.
|
111
|
+
#
|
112
|
+
# The JSON representation for `BytesValue` is JSON string.
|
113
|
+
# @!attribute [rw] value
|
114
|
+
# @return [::String]
|
115
|
+
# The bytes value.
|
116
|
+
class BytesValue
|
117
|
+
include ::Google::Protobuf::MessageExts
|
118
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
119
|
+
end
|
120
|
+
end
|
121
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Rpc
|
22
|
+
# The `Status` type defines a logical error model that is suitable for
|
23
|
+
# different programming environments, including REST APIs and RPC APIs. It is
|
24
|
+
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
25
|
+
# three pieces of data: error code, error message, and error details.
|
26
|
+
#
|
27
|
+
# You can find out more about this error model and how to work with it in the
|
28
|
+
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
29
|
+
# @!attribute [rw] code
|
30
|
+
# @return [::Integer]
|
31
|
+
# The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
|
32
|
+
# @!attribute [rw] message
|
33
|
+
# @return [::String]
|
34
|
+
# A developer-facing error message, which should be in English. Any
|
35
|
+
# user-facing error message should be localized and sent in the
|
36
|
+
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
|
37
|
+
# @!attribute [rw] details
|
38
|
+
# @return [::Array<::Google::Protobuf::Any>]
|
39
|
+
# A list of messages that carry the error details. There is a common set of
|
40
|
+
# message types for APIs to use.
|
41
|
+
class Status
|
42
|
+
include ::Google::Protobuf::MessageExts
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Type
|
22
|
+
# Represents an amount of money with its currency type.
|
23
|
+
# @!attribute [rw] currency_code
|
24
|
+
# @return [::String]
|
25
|
+
# The 3-letter currency code defined in ISO 4217.
|
26
|
+
# @!attribute [rw] units
|
27
|
+
# @return [::Integer]
|
28
|
+
# The whole units of the amount.
|
29
|
+
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
|
30
|
+
# @!attribute [rw] nanos
|
31
|
+
# @return [::Integer]
|
32
|
+
# Number of nano (10^-9) units of the amount.
|
33
|
+
# The value must be between -999,999,999 and +999,999,999 inclusive.
|
34
|
+
# If `units` is positive, `nanos` must be positive or zero.
|
35
|
+
# If `units` is zero, `nanos` can be positive, zero, or negative.
|
36
|
+
# If `units` is negative, `nanos` must be negative or zero.
|
37
|
+
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
|
38
|
+
class Money
|
39
|
+
include ::Google::Protobuf::MessageExts
|
40
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,135 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2021 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Type
|
22
|
+
# Represents a postal address, e.g. for postal delivery or payments addresses.
|
23
|
+
# Given a postal address, a postal service can deliver items to a premise, P.O.
|
24
|
+
# Box or similar.
|
25
|
+
# It is not intended to model geographical locations (roads, towns,
|
26
|
+
# mountains).
|
27
|
+
#
|
28
|
+
# In typical usage an address would be created via user input or from importing
|
29
|
+
# existing data, depending on the type of process.
|
30
|
+
#
|
31
|
+
# Advice on address input / editing:
|
32
|
+
# - Use an i18n-ready address widget such as
|
33
|
+
# https://github.com/google/libaddressinput)
|
34
|
+
# - Users should not be presented with UI elements for input or editing of
|
35
|
+
# fields outside countries where that field is used.
|
36
|
+
#
|
37
|
+
# For more guidance on how to use this schema, please see:
|
38
|
+
# https://support.google.com/business/answer/6397478
|
39
|
+
# @!attribute [rw] revision
|
40
|
+
# @return [::Integer]
|
41
|
+
# The schema revision of the `PostalAddress`. This must be set to 0, which is
|
42
|
+
# the latest revision.
|
43
|
+
#
|
44
|
+
# All new revisions **must** be backward compatible with old revisions.
|
45
|
+
# @!attribute [rw] region_code
|
46
|
+
# @return [::String]
|
47
|
+
# Required. CLDR region code of the country/region of the address. This
|
48
|
+
# is never inferred and it is up to the user to ensure the value is
|
49
|
+
# correct. See http://cldr.unicode.org/ and
|
50
|
+
# http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html
|
51
|
+
# for details. Example: "CH" for Switzerland.
|
52
|
+
# @!attribute [rw] language_code
|
53
|
+
# @return [::String]
|
54
|
+
# Optional. BCP-47 language code of the contents of this address (if
|
55
|
+
# known). This is often the UI language of the input form or is expected
|
56
|
+
# to match one of the languages used in the address' country/region, or their
|
57
|
+
# transliterated equivalents.
|
58
|
+
# This can affect formatting in certain countries, but is not critical
|
59
|
+
# to the correctness of the data and will never affect any validation or
|
60
|
+
# other non-formatting related operations.
|
61
|
+
#
|
62
|
+
# If this value is not known, it should be omitted (rather than specifying a
|
63
|
+
# possibly incorrect default).
|
64
|
+
#
|
65
|
+
# Examples: "zh-Hant", "ja", "ja-Latn", "en".
|
66
|
+
# @!attribute [rw] postal_code
|
67
|
+
# @return [::String]
|
68
|
+
# Optional. Postal code of the address. Not all countries use or require
|
69
|
+
# postal codes to be present, but where they are used, they may trigger
|
70
|
+
# additional validation with other parts of the address (e.g. state/zip
|
71
|
+
# validation in the U.S.A.).
|
72
|
+
# @!attribute [rw] sorting_code
|
73
|
+
# @return [::String]
|
74
|
+
# Optional. Additional, country-specific, sorting code. This is not used
|
75
|
+
# in most regions. Where it is used, the value is either a string like
|
76
|
+
# "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number
|
77
|
+
# alone, representing the "sector code" (Jamaica), "delivery area indicator"
|
78
|
+
# (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
|
79
|
+
# @!attribute [rw] administrative_area
|
80
|
+
# @return [::String]
|
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
|
+
# @!attribute [rw] locality
|
89
|
+
# @return [::String]
|
90
|
+
# Optional. Generally refers to the city/town portion of the address.
|
91
|
+
# Examples: US city, IT comune, UK post town.
|
92
|
+
# In regions of the world where localities are not well defined or do not fit
|
93
|
+
# into this structure well, leave locality empty and use address_lines.
|
94
|
+
# @!attribute [rw] sublocality
|
95
|
+
# @return [::String]
|
96
|
+
# Optional. Sublocality of the address.
|
97
|
+
# For example, this can be neighborhoods, boroughs, districts.
|
98
|
+
# @!attribute [rw] address_lines
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# Unstructured address lines describing the lower levels of an address.
|
101
|
+
#
|
102
|
+
# Because values in address_lines do not have type information and may
|
103
|
+
# sometimes contain multiple values in a single field (e.g.
|
104
|
+
# "Austin, TX"), it is important that the line order is clear. The order of
|
105
|
+
# address lines should be "envelope order" for the country/region of the
|
106
|
+
# address. In places where this can vary (e.g. Japan), address_language is
|
107
|
+
# used to make it explicit (e.g. "ja" for large-to-small ordering and
|
108
|
+
# "ja-Latn" or "en" for small-to-large). This way, the most specific line of
|
109
|
+
# an address can be selected based on the language.
|
110
|
+
#
|
111
|
+
# The minimum permitted structural representation of an address consists
|
112
|
+
# of a region_code with all remaining information placed in the
|
113
|
+
# address_lines. It would be possible to format such an address very
|
114
|
+
# approximately without geocoding, but no semantic reasoning could be
|
115
|
+
# made about any of the address components until it was at least
|
116
|
+
# partially resolved.
|
117
|
+
#
|
118
|
+
# Creating an address only containing a region_code and address_lines, and
|
119
|
+
# then geocoding is the recommended way to handle completely unstructured
|
120
|
+
# addresses (as opposed to guessing which parts of the address should be
|
121
|
+
# localities or administrative areas).
|
122
|
+
# @!attribute [rw] recipients
|
123
|
+
# @return [::Array<::String>]
|
124
|
+
# Optional. The recipient at the address.
|
125
|
+
# This field may, under certain circumstances, contain multiline information.
|
126
|
+
# For example, it might contain "care of" information.
|
127
|
+
# @!attribute [rw] organization
|
128
|
+
# @return [::String]
|
129
|
+
# Optional. The name of the organization at the address.
|
130
|
+
class PostalAddress
|
131
|
+
include ::Google::Protobuf::MessageExts
|
132
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
133
|
+
end
|
134
|
+
end
|
135
|
+
end
|