Documentation ¶
Index ¶
- Variables
- type CalendarPeriod
- func (CalendarPeriod) Descriptor() protoreflect.EnumDescriptor
- func (x CalendarPeriod) Enum() *CalendarPeriod
- func (CalendarPeriod) EnumDescriptor() ([]byte, []int)deprecated
- func (x CalendarPeriod) Number() protoreflect.EnumNumber
- func (x CalendarPeriod) String() string
- func (CalendarPeriod) Type() protoreflect.EnumType
- type Color
- func (m *Color) CloneMessageVT() proto.Message
- func (m *Color) CloneVT() *Color
- func (*Color) Descriptor() ([]byte, []int)deprecated
- func (this *Color) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Color) EqualVT(that *Color) bool
- func (x *Color) GetAlpha() *wrapperspb.FloatValue
- func (x *Color) GetBlue() float32
- func (x *Color) GetGreen() float32
- func (x *Color) GetRed() float32
- func (m *Color) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Color) MarshalToVT(dAtA []byte) (int, error)
- func (m *Color) MarshalVT() (dAtA []byte, err error)
- func (*Color) ProtoMessage()
- func (x *Color) ProtoReflect() protoreflect.Message
- func (x *Color) Reset()
- func (m *Color) SizeVT() (n int)
- func (x *Color) String() string
- func (m *Color) UnmarshalVT(dAtA []byte) error
- func (m *Color) Validate() error
- func (m *Color) ValidateAll() error
- type ColorMultiError
- type ColorValidationError
- type Date
- func (m *Date) CloneMessageVT() proto.Message
- func (m *Date) CloneVT() *Date
- func (*Date) Descriptor() ([]byte, []int)deprecated
- func (this *Date) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Date) EqualVT(that *Date) bool
- func (x *Date) GetDay() int32
- func (x *Date) GetMonth() int32
- func (x *Date) GetYear() int32
- func (m *Date) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Date) MarshalToVT(dAtA []byte) (int, error)
- func (m *Date) MarshalVT() (dAtA []byte, err error)
- func (*Date) ProtoMessage()
- func (x *Date) ProtoReflect() protoreflect.Message
- func (x *Date) Reset()
- func (m *Date) SizeVT() (n int)
- func (x *Date) String() string
- func (m *Date) UnmarshalVT(dAtA []byte) error
- func (m *Date) Validate() error
- func (m *Date) ValidateAll() error
- type DateMultiError
- type DateTime
- func (m *DateTime) CloneMessageVT() proto.Message
- func (m *DateTime) CloneVT() *DateTime
- func (*DateTime) Descriptor() ([]byte, []int)deprecated
- func (this *DateTime) EqualMessageVT(thatMsg proto.Message) bool
- func (this *DateTime) EqualVT(that *DateTime) bool
- func (x *DateTime) GetDay() int32
- func (x *DateTime) GetHours() int32
- func (x *DateTime) GetMinutes() int32
- func (x *DateTime) GetMonth() int32
- func (x *DateTime) GetNanos() int32
- func (x *DateTime) GetSeconds() int32
- func (m *DateTime) GetTimeOffset() isDateTime_TimeOffset
- func (x *DateTime) GetTimeZone() *TimeZone
- func (x *DateTime) GetUtcOffset() *durationpb.Duration
- func (x *DateTime) GetYear() int32
- func (m *DateTime) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *DateTime) MarshalToVT(dAtA []byte) (int, error)
- func (m *DateTime) MarshalVT() (dAtA []byte, err error)
- func (*DateTime) ProtoMessage()
- func (x *DateTime) ProtoReflect() protoreflect.Message
- func (x *DateTime) Reset()
- func (m *DateTime) SizeVT() (n int)
- func (x *DateTime) String() string
- func (m *DateTime) UnmarshalVT(dAtA []byte) error
- func (m *DateTime) Validate() error
- func (m *DateTime) ValidateAll() error
- type DateTimeMultiError
- type DateTimeValidationError
- type DateTime_TimeZone
- func (m *DateTime_TimeZone) CloneVT() isDateTime_TimeOffset
- func (this *DateTime_TimeZone) EqualVT(thatIface isDateTime_TimeOffset) bool
- func (m *DateTime_TimeZone) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *DateTime_TimeZone) MarshalToVT(dAtA []byte) (int, error)
- func (m *DateTime_TimeZone) SizeVT() (n int)
- type DateTime_UtcOffset
- func (m *DateTime_UtcOffset) CloneVT() isDateTime_TimeOffset
- func (this *DateTime_UtcOffset) EqualVT(thatIface isDateTime_TimeOffset) bool
- func (m *DateTime_UtcOffset) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *DateTime_UtcOffset) MarshalToVT(dAtA []byte) (int, error)
- func (m *DateTime_UtcOffset) SizeVT() (n int)
- type DateValidationError
- type DayOfWeek
- type Decimal
- func (m *Decimal) CloneMessageVT() proto.Message
- func (m *Decimal) CloneVT() *Decimal
- func (*Decimal) Descriptor() ([]byte, []int)deprecated
- func (this *Decimal) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Decimal) EqualVT(that *Decimal) bool
- func (x *Decimal) GetValue() string
- func (m *Decimal) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Decimal) MarshalToVT(dAtA []byte) (int, error)
- func (m *Decimal) MarshalVT() (dAtA []byte, err error)
- func (*Decimal) ProtoMessage()
- func (x *Decimal) ProtoReflect() protoreflect.Message
- func (x *Decimal) Reset()
- func (m *Decimal) SizeVT() (n int)
- func (x *Decimal) String() string
- func (m *Decimal) UnmarshalVT(dAtA []byte) error
- func (m *Decimal) Validate() error
- func (m *Decimal) ValidateAll() error
- type DecimalMultiError
- type DecimalValidationError
- type Expr
- func (m *Expr) CloneMessageVT() proto.Message
- func (m *Expr) CloneVT() *Expr
- func (*Expr) Descriptor() ([]byte, []int)deprecated
- func (this *Expr) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Expr) EqualVT(that *Expr) bool
- func (x *Expr) GetDescription() string
- func (x *Expr) GetExpression() string
- func (x *Expr) GetLocation() string
- func (x *Expr) GetTitle() string
- func (m *Expr) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Expr) MarshalToVT(dAtA []byte) (int, error)
- func (m *Expr) MarshalVT() (dAtA []byte, err error)
- func (*Expr) ProtoMessage()
- func (x *Expr) ProtoReflect() protoreflect.Message
- func (x *Expr) Reset()
- func (m *Expr) SizeVT() (n int)
- func (x *Expr) String() string
- func (m *Expr) UnmarshalVT(dAtA []byte) error
- func (m *Expr) Validate() error
- func (m *Expr) ValidateAll() error
- type ExprMultiError
- type ExprValidationError
- type Fraction
- func (m *Fraction) CloneMessageVT() proto.Message
- func (m *Fraction) CloneVT() *Fraction
- func (*Fraction) Descriptor() ([]byte, []int)deprecated
- func (this *Fraction) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Fraction) EqualVT(that *Fraction) bool
- func (x *Fraction) GetDenominator() int64
- func (x *Fraction) GetNumerator() int64
- func (m *Fraction) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Fraction) MarshalToVT(dAtA []byte) (int, error)
- func (m *Fraction) MarshalVT() (dAtA []byte, err error)
- func (*Fraction) ProtoMessage()
- func (x *Fraction) ProtoReflect() protoreflect.Message
- func (x *Fraction) Reset()
- func (m *Fraction) SizeVT() (n int)
- func (x *Fraction) String() string
- func (m *Fraction) UnmarshalVT(dAtA []byte) error
- func (m *Fraction) Validate() error
- func (m *Fraction) ValidateAll() error
- type FractionMultiError
- type FractionValidationError
- type Interval
- func (m *Interval) CloneMessageVT() proto.Message
- func (m *Interval) CloneVT() *Interval
- func (*Interval) Descriptor() ([]byte, []int)deprecated
- func (this *Interval) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Interval) EqualVT(that *Interval) bool
- func (x *Interval) GetEndTime() *timestamppb.Timestamp
- func (x *Interval) GetStartTime() *timestamppb.Timestamp
- func (m *Interval) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Interval) MarshalToVT(dAtA []byte) (int, error)
- func (m *Interval) MarshalVT() (dAtA []byte, err error)
- func (*Interval) ProtoMessage()
- func (x *Interval) ProtoReflect() protoreflect.Message
- func (x *Interval) Reset()
- func (m *Interval) SizeVT() (n int)
- func (x *Interval) String() string
- func (m *Interval) UnmarshalVT(dAtA []byte) error
- func (m *Interval) Validate() error
- func (m *Interval) ValidateAll() error
- type IntervalMultiError
- type IntervalValidationError
- type LatLng
- func (m *LatLng) CloneMessageVT() proto.Message
- func (m *LatLng) CloneVT() *LatLng
- func (*LatLng) Descriptor() ([]byte, []int)deprecated
- func (this *LatLng) EqualMessageVT(thatMsg proto.Message) bool
- func (this *LatLng) EqualVT(that *LatLng) bool
- func (x *LatLng) GetLatitude() float64
- func (x *LatLng) GetLongitude() float64
- func (m *LatLng) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *LatLng) MarshalToVT(dAtA []byte) (int, error)
- func (m *LatLng) MarshalVT() (dAtA []byte, err error)
- func (*LatLng) ProtoMessage()
- func (x *LatLng) ProtoReflect() protoreflect.Message
- func (x *LatLng) Reset()
- func (m *LatLng) SizeVT() (n int)
- func (x *LatLng) String() string
- func (m *LatLng) UnmarshalVT(dAtA []byte) error
- func (m *LatLng) Validate() error
- func (m *LatLng) ValidateAll() error
- type LatLngMultiError
- type LatLngValidationError
- type LocalizedText
- func (m *LocalizedText) CloneMessageVT() proto.Message
- func (m *LocalizedText) CloneVT() *LocalizedText
- func (*LocalizedText) Descriptor() ([]byte, []int)deprecated
- func (this *LocalizedText) EqualMessageVT(thatMsg proto.Message) bool
- func (this *LocalizedText) EqualVT(that *LocalizedText) bool
- func (x *LocalizedText) GetLanguageCode() string
- func (x *LocalizedText) GetText() string
- func (m *LocalizedText) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *LocalizedText) MarshalToVT(dAtA []byte) (int, error)
- func (m *LocalizedText) MarshalVT() (dAtA []byte, err error)
- func (*LocalizedText) ProtoMessage()
- func (x *LocalizedText) ProtoReflect() protoreflect.Message
- func (x *LocalizedText) Reset()
- func (m *LocalizedText) SizeVT() (n int)
- func (x *LocalizedText) String() string
- func (m *LocalizedText) UnmarshalVT(dAtA []byte) error
- func (m *LocalizedText) Validate() error
- func (m *LocalizedText) ValidateAll() error
- type LocalizedTextMultiError
- type LocalizedTextValidationError
- func (e LocalizedTextValidationError) Cause() error
- func (e LocalizedTextValidationError) Error() string
- func (e LocalizedTextValidationError) ErrorName() string
- func (e LocalizedTextValidationError) Field() string
- func (e LocalizedTextValidationError) Key() bool
- func (e LocalizedTextValidationError) Reason() string
- type Money
- func (m *Money) CloneMessageVT() proto.Message
- func (m *Money) CloneVT() *Money
- func (*Money) Descriptor() ([]byte, []int)deprecated
- func (this *Money) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Money) EqualVT(that *Money) bool
- func (x *Money) GetCurrencyCode() string
- func (x *Money) GetNanos() int32
- func (x *Money) GetUnits() int64
- func (m *Money) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Money) MarshalToVT(dAtA []byte) (int, error)
- func (m *Money) MarshalVT() (dAtA []byte, err error)
- func (*Money) ProtoMessage()
- func (x *Money) ProtoReflect() protoreflect.Message
- func (x *Money) Reset()
- func (m *Money) SizeVT() (n int)
- func (x *Money) String() string
- func (m *Money) UnmarshalVT(dAtA []byte) error
- func (m *Money) Validate() error
- func (m *Money) ValidateAll() error
- type MoneyMultiError
- type MoneyValidationError
- type Month
- type PhoneNumber
- func (m *PhoneNumber) CloneMessageVT() proto.Message
- func (m *PhoneNumber) CloneVT() *PhoneNumber
- func (*PhoneNumber) Descriptor() ([]byte, []int)deprecated
- func (this *PhoneNumber) EqualMessageVT(thatMsg proto.Message) bool
- func (this *PhoneNumber) EqualVT(that *PhoneNumber) bool
- func (x *PhoneNumber) GetE164Number() string
- func (x *PhoneNumber) GetExtension() string
- func (m *PhoneNumber) GetKind() isPhoneNumber_Kind
- func (x *PhoneNumber) GetShortCode() *PhoneNumber_ShortCode
- func (m *PhoneNumber) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *PhoneNumber) MarshalToVT(dAtA []byte) (int, error)
- func (m *PhoneNumber) MarshalVT() (dAtA []byte, err error)
- func (*PhoneNumber) ProtoMessage()
- func (x *PhoneNumber) ProtoReflect() protoreflect.Message
- func (x *PhoneNumber) Reset()
- func (m *PhoneNumber) SizeVT() (n int)
- func (x *PhoneNumber) String() string
- func (m *PhoneNumber) UnmarshalVT(dAtA []byte) error
- func (m *PhoneNumber) Validate() error
- func (m *PhoneNumber) ValidateAll() error
- type PhoneNumberMultiError
- type PhoneNumberValidationError
- func (e PhoneNumberValidationError) Cause() error
- func (e PhoneNumberValidationError) Error() string
- func (e PhoneNumberValidationError) ErrorName() string
- func (e PhoneNumberValidationError) Field() string
- func (e PhoneNumberValidationError) Key() bool
- func (e PhoneNumberValidationError) Reason() string
- type PhoneNumber_E164Number
- func (m *PhoneNumber_E164Number) CloneVT() isPhoneNumber_Kind
- func (this *PhoneNumber_E164Number) EqualVT(thatIface isPhoneNumber_Kind) bool
- func (m *PhoneNumber_E164Number) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_E164Number) MarshalToVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_E164Number) SizeVT() (n int)
- type PhoneNumber_ShortCode
- func (m *PhoneNumber_ShortCode) CloneMessageVT() proto.Message
- func (m *PhoneNumber_ShortCode) CloneVT() *PhoneNumber_ShortCode
- func (*PhoneNumber_ShortCode) Descriptor() ([]byte, []int)deprecated
- func (this *PhoneNumber_ShortCode) EqualMessageVT(thatMsg proto.Message) bool
- func (this *PhoneNumber_ShortCode) EqualVT(that *PhoneNumber_ShortCode) bool
- func (x *PhoneNumber_ShortCode) GetNumber() string
- func (x *PhoneNumber_ShortCode) GetRegionCode() string
- func (m *PhoneNumber_ShortCode) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_ShortCode) MarshalToVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_ShortCode) MarshalVT() (dAtA []byte, err error)
- func (*PhoneNumber_ShortCode) ProtoMessage()
- func (x *PhoneNumber_ShortCode) ProtoReflect() protoreflect.Message
- func (x *PhoneNumber_ShortCode) Reset()
- func (m *PhoneNumber_ShortCode) SizeVT() (n int)
- func (x *PhoneNumber_ShortCode) String() string
- func (m *PhoneNumber_ShortCode) UnmarshalVT(dAtA []byte) error
- func (m *PhoneNumber_ShortCode) Validate() error
- func (m *PhoneNumber_ShortCode) ValidateAll() error
- type PhoneNumber_ShortCodeMultiError
- type PhoneNumber_ShortCodeValidationError
- func (e PhoneNumber_ShortCodeValidationError) Cause() error
- func (e PhoneNumber_ShortCodeValidationError) Error() string
- func (e PhoneNumber_ShortCodeValidationError) ErrorName() string
- func (e PhoneNumber_ShortCodeValidationError) Field() string
- func (e PhoneNumber_ShortCodeValidationError) Key() bool
- func (e PhoneNumber_ShortCodeValidationError) Reason() string
- type PhoneNumber_ShortCode_
- func (m *PhoneNumber_ShortCode_) CloneVT() isPhoneNumber_Kind
- func (this *PhoneNumber_ShortCode_) EqualVT(thatIface isPhoneNumber_Kind) bool
- func (m *PhoneNumber_ShortCode_) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_ShortCode_) MarshalToVT(dAtA []byte) (int, error)
- func (m *PhoneNumber_ShortCode_) SizeVT() (n int)
- type PostalAddress
- func (m *PostalAddress) CloneMessageVT() proto.Message
- func (m *PostalAddress) CloneVT() *PostalAddress
- func (*PostalAddress) Descriptor() ([]byte, []int)deprecated
- func (this *PostalAddress) EqualMessageVT(thatMsg proto.Message) bool
- func (this *PostalAddress) EqualVT(that *PostalAddress) bool
- func (x *PostalAddress) GetAddressLines() []string
- func (x *PostalAddress) GetAdministrativeArea() string
- func (x *PostalAddress) GetLanguageCode() string
- func (x *PostalAddress) GetLocality() string
- func (x *PostalAddress) GetOrganization() string
- func (x *PostalAddress) GetPostalCode() string
- func (x *PostalAddress) GetRecipients() []string
- func (x *PostalAddress) GetRegionCode() string
- func (x *PostalAddress) GetRevision() int32
- func (x *PostalAddress) GetSortingCode() string
- func (x *PostalAddress) GetSublocality() string
- func (m *PostalAddress) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *PostalAddress) MarshalToVT(dAtA []byte) (int, error)
- func (m *PostalAddress) MarshalVT() (dAtA []byte, err error)
- func (*PostalAddress) ProtoMessage()
- func (x *PostalAddress) ProtoReflect() protoreflect.Message
- func (x *PostalAddress) Reset()
- func (m *PostalAddress) SizeVT() (n int)
- func (x *PostalAddress) String() string
- func (m *PostalAddress) UnmarshalVT(dAtA []byte) error
- func (m *PostalAddress) Validate() error
- func (m *PostalAddress) ValidateAll() error
- type PostalAddressMultiError
- type PostalAddressValidationError
- func (e PostalAddressValidationError) Cause() error
- func (e PostalAddressValidationError) Error() string
- func (e PostalAddressValidationError) ErrorName() string
- func (e PostalAddressValidationError) Field() string
- func (e PostalAddressValidationError) Key() bool
- func (e PostalAddressValidationError) Reason() string
- type Quaternion
- func (m *Quaternion) CloneMessageVT() proto.Message
- func (m *Quaternion) CloneVT() *Quaternion
- func (*Quaternion) Descriptor() ([]byte, []int)deprecated
- func (this *Quaternion) EqualMessageVT(thatMsg proto.Message) bool
- func (this *Quaternion) EqualVT(that *Quaternion) bool
- func (x *Quaternion) GetW() float64
- func (x *Quaternion) GetX() float64
- func (x *Quaternion) GetY() float64
- func (x *Quaternion) GetZ() float64
- func (m *Quaternion) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Quaternion) MarshalToVT(dAtA []byte) (int, error)
- func (m *Quaternion) MarshalVT() (dAtA []byte, err error)
- func (*Quaternion) ProtoMessage()
- func (x *Quaternion) ProtoReflect() protoreflect.Message
- func (x *Quaternion) Reset()
- func (m *Quaternion) SizeVT() (n int)
- func (x *Quaternion) String() string
- func (m *Quaternion) UnmarshalVT(dAtA []byte) error
- func (m *Quaternion) Validate() error
- func (m *Quaternion) ValidateAll() error
- type QuaternionMultiError
- type QuaternionValidationError
- type TimeOfDay
- func (m *TimeOfDay) CloneMessageVT() proto.Message
- func (m *TimeOfDay) CloneVT() *TimeOfDay
- func (*TimeOfDay) Descriptor() ([]byte, []int)deprecated
- func (this *TimeOfDay) EqualMessageVT(thatMsg proto.Message) bool
- func (this *TimeOfDay) EqualVT(that *TimeOfDay) bool
- func (x *TimeOfDay) GetHours() int32
- func (x *TimeOfDay) GetMinutes() int32
- func (x *TimeOfDay) GetNanos() int32
- func (x *TimeOfDay) GetSeconds() int32
- func (m *TimeOfDay) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *TimeOfDay) MarshalToVT(dAtA []byte) (int, error)
- func (m *TimeOfDay) MarshalVT() (dAtA []byte, err error)
- func (*TimeOfDay) ProtoMessage()
- func (x *TimeOfDay) ProtoReflect() protoreflect.Message
- func (x *TimeOfDay) Reset()
- func (m *TimeOfDay) SizeVT() (n int)
- func (x *TimeOfDay) String() string
- func (m *TimeOfDay) UnmarshalVT(dAtA []byte) error
- func (m *TimeOfDay) Validate() error
- func (m *TimeOfDay) ValidateAll() error
- type TimeOfDayMultiError
- type TimeOfDayValidationError
- type TimeZone
- func (m *TimeZone) CloneMessageVT() proto.Message
- func (m *TimeZone) CloneVT() *TimeZone
- func (*TimeZone) Descriptor() ([]byte, []int)deprecated
- func (this *TimeZone) EqualMessageVT(thatMsg proto.Message) bool
- func (this *TimeZone) EqualVT(that *TimeZone) bool
- func (x *TimeZone) GetId() string
- func (x *TimeZone) GetVersion() string
- func (m *TimeZone) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *TimeZone) MarshalToVT(dAtA []byte) (int, error)
- func (m *TimeZone) MarshalVT() (dAtA []byte, err error)
- func (*TimeZone) ProtoMessage()
- func (x *TimeZone) ProtoReflect() protoreflect.Message
- func (x *TimeZone) Reset()
- func (m *TimeZone) SizeVT() (n int)
- func (x *TimeZone) String() string
- func (m *TimeZone) UnmarshalVT(dAtA []byte) error
- func (m *TimeZone) Validate() error
- func (m *TimeZone) ValidateAll() error
- type TimeZoneMultiError
- type TimeZoneValidationError
Constants ¶
This section is empty.
Variables ¶
var ( CalendarPeriod_name = map[int32]string{ 0: "CALENDAR_PERIOD_UNSPECIFIED", 1: "DAY", 2: "WEEK", 3: "FORTNIGHT", 4: "MONTH", 5: "QUARTER", 6: "HALF", 7: "YEAR", } CalendarPeriod_value = map[string]int32{ "CALENDAR_PERIOD_UNSPECIFIED": 0, "DAY": 1, "WEEK": 2, "FORTNIGHT": 3, "MONTH": 4, "QUARTER": 5, "HALF": 6, "YEAR": 7, } )
Enum value maps for CalendarPeriod.
var ( DayOfWeek_name = map[int32]string{ 0: "DAY_OF_WEEK_UNSPECIFIED", 1: "MONDAY", 2: "TUESDAY", 3: "WEDNESDAY", 4: "THURSDAY", 5: "FRIDAY", 6: "SATURDAY", 7: "SUNDAY", } DayOfWeek_value = map[string]int32{ "DAY_OF_WEEK_UNSPECIFIED": 0, "MONDAY": 1, "TUESDAY": 2, "WEDNESDAY": 3, "THURSDAY": 4, "FRIDAY": 5, "SATURDAY": 6, "SUNDAY": 7, } )
Enum value maps for DayOfWeek.
var ( Month_name = map[int32]string{ 0: "MONTH_UNSPECIFIED", 1: "JANUARY", 2: "FEBRUARY", 3: "MARCH", 4: "APRIL", 5: "MAY", 6: "JUNE", 7: "JULY", 8: "AUGUST", 9: "SEPTEMBER", 10: "OCTOBER", 11: "NOVEMBER", 12: "DECEMBER", } Month_value = map[string]int32{ "MONTH_UNSPECIFIED": 0, "JANUARY": 1, "FEBRUARY": 2, "MARCH": 3, "APRIL": 4, "MAY": 5, "JUNE": 6, "JULY": 7, "AUGUST": 8, "SEPTEMBER": 9, "OCTOBER": 10, "NOVEMBER": 11, "DECEMBER": 12, } )
Enum value maps for Month.
var File_google_type_calendar_period_proto protoreflect.FileDescriptor
var File_google_type_color_proto protoreflect.FileDescriptor
var File_google_type_date_proto protoreflect.FileDescriptor
var File_google_type_datetime_proto protoreflect.FileDescriptor
var File_google_type_dayofweek_proto protoreflect.FileDescriptor
var File_google_type_decimal_proto protoreflect.FileDescriptor
var File_google_type_expr_proto protoreflect.FileDescriptor
var File_google_type_fraction_proto protoreflect.FileDescriptor
var File_google_type_interval_proto protoreflect.FileDescriptor
var File_google_type_latlng_proto protoreflect.FileDescriptor
var File_google_type_localized_text_proto protoreflect.FileDescriptor
var File_google_type_money_proto protoreflect.FileDescriptor
var File_google_type_month_proto protoreflect.FileDescriptor
var File_google_type_phone_number_proto protoreflect.FileDescriptor
var File_google_type_postal_address_proto protoreflect.FileDescriptor
var File_google_type_quaternion_proto protoreflect.FileDescriptor
var File_google_type_timeofday_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type CalendarPeriod ¶
type CalendarPeriod int32
A `CalendarPeriod` represents the abstract concept of a time period that has a canonical start. Grammatically, "the start of the current `CalendarPeriod`." All calendar times begin at midnight UTC.
const ( // Undefined period, raises an error. CalendarPeriod_CALENDAR_PERIOD_UNSPECIFIED CalendarPeriod = 0 // A day. CalendarPeriod_DAY CalendarPeriod = 1 // A week. Weeks begin on Monday, following // [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date). CalendarPeriod_WEEK CalendarPeriod = 2 // A fortnight. The first calendar fortnight of the year begins at the start // of week 1 according to // [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date). CalendarPeriod_FORTNIGHT CalendarPeriod = 3 // A month. CalendarPeriod_MONTH CalendarPeriod = 4 // A quarter. Quarters start on dates 1-Jan, 1-Apr, 1-Jul, and 1-Oct of each // year. CalendarPeriod_QUARTER CalendarPeriod = 5 // A half-year. Half-years start on dates 1-Jan and 1-Jul. CalendarPeriod_HALF CalendarPeriod = 6 // A year. CalendarPeriod_YEAR CalendarPeriod = 7 )
func (CalendarPeriod) Descriptor ¶
func (CalendarPeriod) Descriptor() protoreflect.EnumDescriptor
func (CalendarPeriod) Enum ¶
func (x CalendarPeriod) Enum() *CalendarPeriod
func (CalendarPeriod) EnumDescriptor
deprecated
func (CalendarPeriod) EnumDescriptor() ([]byte, []int)
Deprecated: Use CalendarPeriod.Descriptor instead.
func (CalendarPeriod) Number ¶
func (x CalendarPeriod) Number() protoreflect.EnumNumber
func (CalendarPeriod) String ¶
func (x CalendarPeriod) String() string
func (CalendarPeriod) Type ¶
func (CalendarPeriod) Type() protoreflect.EnumType
type Color ¶
type Color struct { // The amount of red in the color as a value in the interval [0, 1]. Red float32 `protobuf:"fixed32,1,opt,name=red,proto3" json:"red,omitempty"` // The amount of green in the color as a value in the interval [0, 1]. Green float32 `protobuf:"fixed32,2,opt,name=green,proto3" json:"green,omitempty"` // The amount of blue in the color as a value in the interval [0, 1]. Blue float32 `protobuf:"fixed32,3,opt,name=blue,proto3" json:"blue,omitempty"` // The fraction of this color that should be applied to the pixel. That is, // the final pixel color is defined by the equation: // // `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` // // This means that a value of 1.0 corresponds to a solid color, whereas // a value of 0.0 corresponds to a completely transparent color. This // uses a wrapper message rather than a simple float scalar so that it is // possible to distinguish between a default value and the value being unset. // If omitted, this color object is rendered as a solid color // (as if the alpha value had been explicitly given a value of 1.0). Alpha *wrapperspb.FloatValue `protobuf:"bytes,4,opt,name=alpha,proto3" json:"alpha,omitempty"` // contains filtered or unexported fields }
Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript.
This reference page doesn't carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color space.
When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5.
Example (Java):
import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ...
Example (iOS / Obj-C):
// ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...
func (*Color) CloneMessageVT ¶
func (*Color) Descriptor
deprecated
func (*Color) GetAlpha ¶
func (x *Color) GetAlpha() *wrapperspb.FloatValue
func (*Color) MarshalToSizedBufferVT ¶
func (*Color) ProtoMessage ¶
func (*Color) ProtoMessage()
func (*Color) ProtoReflect ¶
func (x *Color) ProtoReflect() protoreflect.Message
func (*Color) UnmarshalVT ¶
func (*Color) Validate ¶
Validate checks the field values on Color with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Color) ValidateAll ¶
ValidateAll checks the field values on Color with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ColorMultiError, or nil if none found.
type ColorMultiError ¶
type ColorMultiError []error
ColorMultiError is an error wrapping multiple validation errors returned by Color.ValidateAll() if the designated constraints aren't met.
func (ColorMultiError) AllErrors ¶
func (m ColorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ColorMultiError) Error ¶
func (m ColorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ColorValidationError ¶
type ColorValidationError struct {
// contains filtered or unexported fields
}
ColorValidationError is the validation error returned by Color.Validate if the designated constraints aren't met.
func (ColorValidationError) Cause ¶
func (e ColorValidationError) Cause() error
Cause function returns cause value.
func (ColorValidationError) Error ¶
func (e ColorValidationError) Error() string
Error satisfies the builtin error interface
func (ColorValidationError) ErrorName ¶
func (e ColorValidationError) ErrorName() string
ErrorName returns error name.
func (ColorValidationError) Field ¶
func (e ColorValidationError) Field() string
Field function returns field value.
func (ColorValidationError) Key ¶
func (e ColorValidationError) Key() bool
Key function returns key value.
func (ColorValidationError) Reason ¶
func (e ColorValidationError) Reason() string
Reason function returns reason value.
type Date ¶
type Date struct { // Year of the date. Must be from 1 to 9999, or 0 to specify a date without // a year. Year int32 `protobuf:"varint,1,opt,name=year,proto3" json:"year,omitempty"` // Month of a year. Must be from 1 to 12, or 0 to specify a year without a // month and day. Month int32 `protobuf:"varint,2,opt,name=month,proto3" json:"month,omitempty"` // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 // to specify a year by itself or a year and month where the day isn't // significant. Day int32 `protobuf:"varint,3,opt,name=day,proto3" json:"day,omitempty"` // contains filtered or unexported fields }
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:
* A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date
Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and `google.protobuf.Timestamp`.
func (*Date) CloneMessageVT ¶
func (*Date) Descriptor
deprecated
func (*Date) MarshalToSizedBufferVT ¶
func (*Date) ProtoMessage ¶
func (*Date) ProtoMessage()
func (*Date) ProtoReflect ¶
func (x *Date) ProtoReflect() protoreflect.Message
func (*Date) UnmarshalVT ¶
func (*Date) Validate ¶
Validate checks the field values on Date with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Date) ValidateAll ¶
ValidateAll checks the field values on Date with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DateMultiError, or nil if none found.
type DateMultiError ¶
type DateMultiError []error
DateMultiError is an error wrapping multiple validation errors returned by Date.ValidateAll() if the designated constraints aren't met.
func (DateMultiError) AllErrors ¶
func (m DateMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DateMultiError) Error ¶
func (m DateMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DateTime ¶
type DateTime struct { // Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a // datetime without a year. Year int32 `protobuf:"varint,1,opt,name=year,proto3" json:"year,omitempty"` // Required. Month of year. Must be from 1 to 12. Month int32 `protobuf:"varint,2,opt,name=month,proto3" json:"month,omitempty"` // Required. Day of month. Must be from 1 to 31 and valid for the year and // month. Day int32 `protobuf:"varint,3,opt,name=day,proto3" json:"day,omitempty"` // Required. Hours of day in 24 hour format. Should be from 0 to 23. An API // may choose to allow the value "24:00:00" for scenarios like business // closing time. Hours int32 `protobuf:"varint,4,opt,name=hours,proto3" json:"hours,omitempty"` // Required. Minutes of hour of day. Must be from 0 to 59. Minutes int32 `protobuf:"varint,5,opt,name=minutes,proto3" json:"minutes,omitempty"` // Required. Seconds of minutes of the time. Must normally be from 0 to 59. An // API may allow the value 60 if it allows leap-seconds. Seconds int32 `protobuf:"varint,6,opt,name=seconds,proto3" json:"seconds,omitempty"` // Required. Fractions of seconds in nanoseconds. Must be from 0 to // 999,999,999. Nanos int32 `protobuf:"varint,7,opt,name=nanos,proto3" json:"nanos,omitempty"` // Optional. Specifies either the UTC offset or the time zone of the DateTime. // Choose carefully between them, considering that time zone data may change // in the future (for example, a country modifies their DST start/end dates, // and future DateTimes in the affected range had already been stored). // If omitted, the DateTime is considered to be in local time. // // Types that are assignable to TimeOffset: // // *DateTime_UtcOffset // *DateTime_TimeZone TimeOffset isDateTime_TimeOffset `protobuf_oneof:"time_offset"` // contains filtered or unexported fields }
Represents civil time (or occasionally physical time).
This type can represent a civil time in one of a few possible ways:
- When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
- When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
- When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time.
The date is relative to the Proleptic Gregorian Calendar.
If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values.
This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field.
This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
func (*DateTime) CloneMessageVT ¶
func (*DateTime) Descriptor
deprecated
func (*DateTime) GetMinutes ¶
func (*DateTime) GetSeconds ¶
func (*DateTime) GetTimeOffset ¶
func (m *DateTime) GetTimeOffset() isDateTime_TimeOffset
func (*DateTime) GetTimeZone ¶
func (*DateTime) GetUtcOffset ¶
func (x *DateTime) GetUtcOffset() *durationpb.Duration
func (*DateTime) MarshalToSizedBufferVT ¶
func (*DateTime) ProtoMessage ¶
func (*DateTime) ProtoMessage()
func (*DateTime) ProtoReflect ¶
func (x *DateTime) ProtoReflect() protoreflect.Message
func (*DateTime) UnmarshalVT ¶
func (*DateTime) Validate ¶
Validate checks the field values on DateTime with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*DateTime) ValidateAll ¶
ValidateAll checks the field values on DateTime with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DateTimeMultiError, or nil if none found.
type DateTimeMultiError ¶
type DateTimeMultiError []error
DateTimeMultiError is an error wrapping multiple validation errors returned by DateTime.ValidateAll() if the designated constraints aren't met.
func (DateTimeMultiError) AllErrors ¶
func (m DateTimeMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DateTimeMultiError) Error ¶
func (m DateTimeMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DateTimeValidationError ¶
type DateTimeValidationError struct {
// contains filtered or unexported fields
}
DateTimeValidationError is the validation error returned by DateTime.Validate if the designated constraints aren't met.
func (DateTimeValidationError) Cause ¶
func (e DateTimeValidationError) Cause() error
Cause function returns cause value.
func (DateTimeValidationError) Error ¶
func (e DateTimeValidationError) Error() string
Error satisfies the builtin error interface
func (DateTimeValidationError) ErrorName ¶
func (e DateTimeValidationError) ErrorName() string
ErrorName returns error name.
func (DateTimeValidationError) Field ¶
func (e DateTimeValidationError) Field() string
Field function returns field value.
func (DateTimeValidationError) Key ¶
func (e DateTimeValidationError) Key() bool
Key function returns key value.
func (DateTimeValidationError) Reason ¶
func (e DateTimeValidationError) Reason() string
Reason function returns reason value.
type DateTime_TimeZone ¶
type DateTime_TimeZone struct { // Time zone. TimeZone *TimeZone `protobuf:"bytes,9,opt,name=time_zone,json=timeZone,proto3,oneof"` }
func (*DateTime_TimeZone) CloneVT ¶
func (m *DateTime_TimeZone) CloneVT() isDateTime_TimeOffset
func (*DateTime_TimeZone) EqualVT ¶
func (this *DateTime_TimeZone) EqualVT(thatIface isDateTime_TimeOffset) bool
func (*DateTime_TimeZone) MarshalToSizedBufferVT ¶
func (m *DateTime_TimeZone) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*DateTime_TimeZone) MarshalToVT ¶
func (m *DateTime_TimeZone) MarshalToVT(dAtA []byte) (int, error)
func (*DateTime_TimeZone) SizeVT ¶
func (m *DateTime_TimeZone) SizeVT() (n int)
type DateTime_UtcOffset ¶
type DateTime_UtcOffset struct { // UTC offset. Must be whole seconds, between -18 hours and +18 hours. // For example, a UTC offset of -4:00 would be represented as // { seconds: -14400 }. UtcOffset *durationpb.Duration `protobuf:"bytes,8,opt,name=utc_offset,json=utcOffset,proto3,oneof"` }
func (*DateTime_UtcOffset) CloneVT ¶
func (m *DateTime_UtcOffset) CloneVT() isDateTime_TimeOffset
func (*DateTime_UtcOffset) EqualVT ¶
func (this *DateTime_UtcOffset) EqualVT(thatIface isDateTime_TimeOffset) bool
func (*DateTime_UtcOffset) MarshalToSizedBufferVT ¶
func (m *DateTime_UtcOffset) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*DateTime_UtcOffset) MarshalToVT ¶
func (m *DateTime_UtcOffset) MarshalToVT(dAtA []byte) (int, error)
func (*DateTime_UtcOffset) SizeVT ¶
func (m *DateTime_UtcOffset) SizeVT() (n int)
type DateValidationError ¶
type DateValidationError struct {
// contains filtered or unexported fields
}
DateValidationError is the validation error returned by Date.Validate if the designated constraints aren't met.
func (DateValidationError) Cause ¶
func (e DateValidationError) Cause() error
Cause function returns cause value.
func (DateValidationError) Error ¶
func (e DateValidationError) Error() string
Error satisfies the builtin error interface
func (DateValidationError) ErrorName ¶
func (e DateValidationError) ErrorName() string
ErrorName returns error name.
func (DateValidationError) Field ¶
func (e DateValidationError) Field() string
Field function returns field value.
func (DateValidationError) Key ¶
func (e DateValidationError) Key() bool
Key function returns key value.
func (DateValidationError) Reason ¶
func (e DateValidationError) Reason() string
Reason function returns reason value.
type DayOfWeek ¶
type DayOfWeek int32
Represents a day of the week.
const ( // The day of the week is unspecified. DayOfWeek_DAY_OF_WEEK_UNSPECIFIED DayOfWeek = 0 // Monday DayOfWeek_MONDAY DayOfWeek = 1 // Tuesday DayOfWeek_TUESDAY DayOfWeek = 2 // Wednesday DayOfWeek_WEDNESDAY DayOfWeek = 3 // Thursday DayOfWeek_THURSDAY DayOfWeek = 4 // Friday DayOfWeek_FRIDAY DayOfWeek = 5 // Saturday DayOfWeek_SATURDAY DayOfWeek = 6 // Sunday DayOfWeek_SUNDAY DayOfWeek = 7 )
func (DayOfWeek) Descriptor ¶
func (DayOfWeek) Descriptor() protoreflect.EnumDescriptor
func (DayOfWeek) EnumDescriptor
deprecated
func (DayOfWeek) Number ¶
func (x DayOfWeek) Number() protoreflect.EnumNumber
func (DayOfWeek) Type ¶
func (DayOfWeek) Type() protoreflect.EnumType
type Decimal ¶
type Decimal struct { // The decimal value, as a string. // // The string representation consists of an optional sign, `+` (`U+002B`) // or `-` (`U+002D`), followed by a sequence of zero or more decimal digits // ("the integer"), optionally followed by a fraction, optionally followed // by an exponent. // // The fraction consists of a decimal point followed by zero or more decimal // digits. The string must contain at least one digit in either the integer // or the fraction. The number formed by the sign, the integer and the // fraction is referred to as the significand. // // The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) // followed by one or more decimal digits. // // Services **should** normalize decimal values before storing them by: // // - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). // - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). // - Coercing the exponent character to lower-case (`2.5E8` -> `2.5e8`). // - Removing an explicitly-provided zero exponent (`2.5e0` -> `2.5`). // // Services **may** perform additional normalization based on its own needs // and the internal decimal implementation selected, such as shifting the // decimal point and exponent value together (example: `2.5e-1` <-> `0.25`). // Additionally, services **may** preserve trailing zeroes in the fraction // to indicate increased precision, but are not required to do so. // // Note that only the `.` character is supported to divide the integer // and the fraction; `,` **should not** be supported regardless of locale. // Additionally, thousand separators **should not** be supported. If a // service does support them, values **must** be normalized. // // The ENBF grammar is: // // DecimalString = // [Sign] Significand [Exponent]; // // Sign = '+' | '-'; // // Significand = // Digits ['.'] [Digits] | [Digits] '.' Digits; // // Exponent = ('e' | 'E') [Sign] Digits; // // Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; // // Services **should** clearly document the range of supported values, the // maximum supported precision (total number of digits), and, if applicable, // the scale (number of digits after the decimal point), as well as how it // behaves when receiving out-of-bounds values. // // Services **may** choose to accept values passed as input even when the // value has a higher precision or scale than the service supports, and // **should** round the value to fit the supported scale. Alternatively, the // service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) // if precision would be lost. // // Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in // gRPC) if the service receives a value outside of the supported range. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][].
[BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html
func (*Decimal) CloneMessageVT ¶
func (*Decimal) Descriptor
deprecated
func (*Decimal) MarshalToSizedBufferVT ¶
func (*Decimal) ProtoMessage ¶
func (*Decimal) ProtoMessage()
func (*Decimal) ProtoReflect ¶
func (x *Decimal) ProtoReflect() protoreflect.Message
func (*Decimal) UnmarshalVT ¶
func (*Decimal) Validate ¶
Validate checks the field values on Decimal with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Decimal) ValidateAll ¶
ValidateAll checks the field values on Decimal with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DecimalMultiError, or nil if none found.
type DecimalMultiError ¶
type DecimalMultiError []error
DecimalMultiError is an error wrapping multiple validation errors returned by Decimal.ValidateAll() if the designated constraints aren't met.
func (DecimalMultiError) AllErrors ¶
func (m DecimalMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DecimalMultiError) Error ¶
func (m DecimalMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DecimalValidationError ¶
type DecimalValidationError struct {
// contains filtered or unexported fields
}
DecimalValidationError is the validation error returned by Decimal.Validate if the designated constraints aren't met.
func (DecimalValidationError) Cause ¶
func (e DecimalValidationError) Cause() error
Cause function returns cause value.
func (DecimalValidationError) Error ¶
func (e DecimalValidationError) Error() string
Error satisfies the builtin error interface
func (DecimalValidationError) ErrorName ¶
func (e DecimalValidationError) ErrorName() string
ErrorName returns error name.
func (DecimalValidationError) Field ¶
func (e DecimalValidationError) Field() string
Field function returns field value.
func (DecimalValidationError) Key ¶
func (e DecimalValidationError) Key() bool
Key function returns key value.
func (DecimalValidationError) Reason ¶
func (e DecimalValidationError) Reason() string
Reason function returns reason value.
type Expr ¶
type Expr struct { // Textual representation of an expression in Common Expression Language // syntax. Expression string `protobuf:"bytes,1,opt,name=expression,proto3" json:"expression,omitempty"` // Optional. Title for the expression, i.e. a short string describing // its purpose. This can be used e.g. in UIs which allow to enter the // expression. Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` // Optional. Description of the expression. This is a longer text which // describes the expression, e.g. when hovered over it in a UI. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // Optional. String indicating the location of the expression for error // reporting, e.g. a file name and a position in the file. Location string `protobuf:"bytes,4,opt,name=location,proto3" json:"location,omitempty"` // contains filtered or unexported fields }
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.
Example (Comparison):
title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"
Example (Equality):
title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"
Example (Logic):
title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"
Example (Data Manipulation):
title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"
The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
func (*Expr) CloneMessageVT ¶
func (*Expr) Descriptor
deprecated
func (*Expr) GetDescription ¶
func (*Expr) GetExpression ¶
func (*Expr) GetLocation ¶
func (*Expr) MarshalToSizedBufferVT ¶
func (*Expr) ProtoMessage ¶
func (*Expr) ProtoMessage()
func (*Expr) ProtoReflect ¶
func (x *Expr) ProtoReflect() protoreflect.Message
func (*Expr) UnmarshalVT ¶
func (*Expr) Validate ¶
Validate checks the field values on Expr with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Expr) ValidateAll ¶
ValidateAll checks the field values on Expr with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ExprMultiError, or nil if none found.
type ExprMultiError ¶
type ExprMultiError []error
ExprMultiError is an error wrapping multiple validation errors returned by Expr.ValidateAll() if the designated constraints aren't met.
func (ExprMultiError) AllErrors ¶
func (m ExprMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ExprMultiError) Error ¶
func (m ExprMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ExprValidationError ¶
type ExprValidationError struct {
// contains filtered or unexported fields
}
ExprValidationError is the validation error returned by Expr.Validate if the designated constraints aren't met.
func (ExprValidationError) Cause ¶
func (e ExprValidationError) Cause() error
Cause function returns cause value.
func (ExprValidationError) Error ¶
func (e ExprValidationError) Error() string
Error satisfies the builtin error interface
func (ExprValidationError) ErrorName ¶
func (e ExprValidationError) ErrorName() string
ErrorName returns error name.
func (ExprValidationError) Field ¶
func (e ExprValidationError) Field() string
Field function returns field value.
func (ExprValidationError) Key ¶
func (e ExprValidationError) Key() bool
Key function returns key value.
func (ExprValidationError) Reason ¶
func (e ExprValidationError) Reason() string
Reason function returns reason value.
type Fraction ¶
type Fraction struct { // The numerator in the fraction, e.g. 2 in 2/3. Numerator int64 `protobuf:"varint,1,opt,name=numerator,proto3" json:"numerator,omitempty"` // The value by which the numerator is divided, e.g. 3 in 2/3. Must be // positive. Denominator int64 `protobuf:"varint,2,opt,name=denominator,proto3" json:"denominator,omitempty"` // contains filtered or unexported fields }
Represents a fraction in terms of a numerator divided by a denominator.
func (*Fraction) CloneMessageVT ¶
func (*Fraction) Descriptor
deprecated
func (*Fraction) GetDenominator ¶
func (*Fraction) GetNumerator ¶
func (*Fraction) MarshalToSizedBufferVT ¶
func (*Fraction) ProtoMessage ¶
func (*Fraction) ProtoMessage()
func (*Fraction) ProtoReflect ¶
func (x *Fraction) ProtoReflect() protoreflect.Message
func (*Fraction) UnmarshalVT ¶
func (*Fraction) Validate ¶
Validate checks the field values on Fraction with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Fraction) ValidateAll ¶
ValidateAll checks the field values on Fraction with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in FractionMultiError, or nil if none found.
type FractionMultiError ¶
type FractionMultiError []error
FractionMultiError is an error wrapping multiple validation errors returned by Fraction.ValidateAll() if the designated constraints aren't met.
func (FractionMultiError) AllErrors ¶
func (m FractionMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FractionMultiError) Error ¶
func (m FractionMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FractionValidationError ¶
type FractionValidationError struct {
// contains filtered or unexported fields
}
FractionValidationError is the validation error returned by Fraction.Validate if the designated constraints aren't met.
func (FractionValidationError) Cause ¶
func (e FractionValidationError) Cause() error
Cause function returns cause value.
func (FractionValidationError) Error ¶
func (e FractionValidationError) Error() string
Error satisfies the builtin error interface
func (FractionValidationError) ErrorName ¶
func (e FractionValidationError) ErrorName() string
ErrorName returns error name.
func (FractionValidationError) Field ¶
func (e FractionValidationError) Field() string
Field function returns field value.
func (FractionValidationError) Key ¶
func (e FractionValidationError) Key() bool
Key function returns key value.
func (FractionValidationError) Reason ¶
func (e FractionValidationError) Reason() string
Reason function returns reason value.
type Interval ¶
type Interval struct { // Optional. Inclusive start of the interval. // // If specified, a Timestamp matching this interval will have to be the same // or after the start. StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // Optional. Exclusive end of the interval. // // If specified, a Timestamp matching this interval will have to be before the // end. EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // contains filtered or unexported fields }
Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
func (*Interval) CloneMessageVT ¶
func (*Interval) Descriptor
deprecated
func (*Interval) GetEndTime ¶
func (x *Interval) GetEndTime() *timestamppb.Timestamp
func (*Interval) GetStartTime ¶
func (x *Interval) GetStartTime() *timestamppb.Timestamp
func (*Interval) MarshalToSizedBufferVT ¶
func (*Interval) ProtoMessage ¶
func (*Interval) ProtoMessage()
func (*Interval) ProtoReflect ¶
func (x *Interval) ProtoReflect() protoreflect.Message
func (*Interval) UnmarshalVT ¶
func (*Interval) Validate ¶
Validate checks the field values on Interval with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Interval) ValidateAll ¶
ValidateAll checks the field values on Interval with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in IntervalMultiError, or nil if none found.
type IntervalMultiError ¶
type IntervalMultiError []error
IntervalMultiError is an error wrapping multiple validation errors returned by Interval.ValidateAll() if the designated constraints aren't met.
func (IntervalMultiError) AllErrors ¶
func (m IntervalMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (IntervalMultiError) Error ¶
func (m IntervalMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type IntervalValidationError ¶
type IntervalValidationError struct {
// contains filtered or unexported fields
}
IntervalValidationError is the validation error returned by Interval.Validate if the designated constraints aren't met.
func (IntervalValidationError) Cause ¶
func (e IntervalValidationError) Cause() error
Cause function returns cause value.
func (IntervalValidationError) Error ¶
func (e IntervalValidationError) Error() string
Error satisfies the builtin error interface
func (IntervalValidationError) ErrorName ¶
func (e IntervalValidationError) ErrorName() string
ErrorName returns error name.
func (IntervalValidationError) Field ¶
func (e IntervalValidationError) Field() string
Field function returns field value.
func (IntervalValidationError) Key ¶
func (e IntervalValidationError) Key() bool
Key function returns key value.
func (IntervalValidationError) Reason ¶
func (e IntervalValidationError) Reason() string
Reason function returns reason value.
type LatLng ¶
type LatLng struct { // The latitude in degrees. It must be in the range [-90.0, +90.0]. Latitude float64 `protobuf:"fixed64,1,opt,name=latitude,proto3" json:"latitude,omitempty"` // The longitude in degrees. It must be in the range [-180.0, +180.0]. Longitude float64 `protobuf:"fixed64,2,opt,name=longitude,proto3" json:"longitude,omitempty"` // contains filtered or unexported fields }
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
func (*LatLng) CloneMessageVT ¶
func (*LatLng) Descriptor
deprecated
func (*LatLng) GetLatitude ¶
func (*LatLng) GetLongitude ¶
func (*LatLng) MarshalToSizedBufferVT ¶
func (*LatLng) ProtoMessage ¶
func (*LatLng) ProtoMessage()
func (*LatLng) ProtoReflect ¶
func (x *LatLng) ProtoReflect() protoreflect.Message
func (*LatLng) UnmarshalVT ¶
func (*LatLng) Validate ¶
Validate checks the field values on LatLng with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*LatLng) ValidateAll ¶
ValidateAll checks the field values on LatLng with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LatLngMultiError, or nil if none found.
type LatLngMultiError ¶
type LatLngMultiError []error
LatLngMultiError is an error wrapping multiple validation errors returned by LatLng.ValidateAll() if the designated constraints aren't met.
func (LatLngMultiError) AllErrors ¶
func (m LatLngMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (LatLngMultiError) Error ¶
func (m LatLngMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type LatLngValidationError ¶
type LatLngValidationError struct {
// contains filtered or unexported fields
}
LatLngValidationError is the validation error returned by LatLng.Validate if the designated constraints aren't met.
func (LatLngValidationError) Cause ¶
func (e LatLngValidationError) Cause() error
Cause function returns cause value.
func (LatLngValidationError) Error ¶
func (e LatLngValidationError) Error() string
Error satisfies the builtin error interface
func (LatLngValidationError) ErrorName ¶
func (e LatLngValidationError) ErrorName() string
ErrorName returns error name.
func (LatLngValidationError) Field ¶
func (e LatLngValidationError) Field() string
Field function returns field value.
func (LatLngValidationError) Key ¶
func (e LatLngValidationError) Key() bool
Key function returns key value.
func (LatLngValidationError) Reason ¶
func (e LatLngValidationError) Reason() string
Reason function returns reason value.
type LocalizedText ¶
type LocalizedText struct { // Localized string in the language corresponding to `language_code' below. Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // The text's BCP-47 language code, such as "en-US" or "sr-Latn". // // For more information, see // http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. LanguageCode string `protobuf:"bytes,2,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"` // contains filtered or unexported fields }
Localized variant of a text in a particular language.
func (*LocalizedText) CloneMessageVT ¶
func (m *LocalizedText) CloneMessageVT() proto.Message
func (*LocalizedText) CloneVT ¶
func (m *LocalizedText) CloneVT() *LocalizedText
func (*LocalizedText) Descriptor
deprecated
func (*LocalizedText) Descriptor() ([]byte, []int)
Deprecated: Use LocalizedText.ProtoReflect.Descriptor instead.
func (*LocalizedText) EqualMessageVT ¶
func (this *LocalizedText) EqualMessageVT(thatMsg proto.Message) bool
func (*LocalizedText) EqualVT ¶
func (this *LocalizedText) EqualVT(that *LocalizedText) bool
func (*LocalizedText) GetLanguageCode ¶
func (x *LocalizedText) GetLanguageCode() string
func (*LocalizedText) GetText ¶
func (x *LocalizedText) GetText() string
func (*LocalizedText) MarshalToSizedBufferVT ¶
func (m *LocalizedText) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*LocalizedText) MarshalToVT ¶
func (m *LocalizedText) MarshalToVT(dAtA []byte) (int, error)
func (*LocalizedText) MarshalVT ¶
func (m *LocalizedText) MarshalVT() (dAtA []byte, err error)
func (*LocalizedText) ProtoMessage ¶
func (*LocalizedText) ProtoMessage()
func (*LocalizedText) ProtoReflect ¶
func (x *LocalizedText) ProtoReflect() protoreflect.Message
func (*LocalizedText) Reset ¶
func (x *LocalizedText) Reset()
func (*LocalizedText) SizeVT ¶
func (m *LocalizedText) SizeVT() (n int)
func (*LocalizedText) String ¶
func (x *LocalizedText) String() string
func (*LocalizedText) UnmarshalVT ¶
func (m *LocalizedText) UnmarshalVT(dAtA []byte) error
func (*LocalizedText) Validate ¶
func (m *LocalizedText) Validate() error
Validate checks the field values on LocalizedText with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*LocalizedText) ValidateAll ¶
func (m *LocalizedText) ValidateAll() error
ValidateAll checks the field values on LocalizedText with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in LocalizedTextMultiError, or nil if none found.
type LocalizedTextMultiError ¶
type LocalizedTextMultiError []error
LocalizedTextMultiError is an error wrapping multiple validation errors returned by LocalizedText.ValidateAll() if the designated constraints aren't met.
func (LocalizedTextMultiError) AllErrors ¶
func (m LocalizedTextMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (LocalizedTextMultiError) Error ¶
func (m LocalizedTextMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type LocalizedTextValidationError ¶
type LocalizedTextValidationError struct {
// contains filtered or unexported fields
}
LocalizedTextValidationError is the validation error returned by LocalizedText.Validate if the designated constraints aren't met.
func (LocalizedTextValidationError) Cause ¶
func (e LocalizedTextValidationError) Cause() error
Cause function returns cause value.
func (LocalizedTextValidationError) Error ¶
func (e LocalizedTextValidationError) Error() string
Error satisfies the builtin error interface
func (LocalizedTextValidationError) ErrorName ¶
func (e LocalizedTextValidationError) ErrorName() string
ErrorName returns error name.
func (LocalizedTextValidationError) Field ¶
func (e LocalizedTextValidationError) Field() string
Field function returns field value.
func (LocalizedTextValidationError) Key ¶
func (e LocalizedTextValidationError) Key() bool
Key function returns key value.
func (LocalizedTextValidationError) Reason ¶
func (e LocalizedTextValidationError) Reason() string
Reason function returns reason value.
type Money ¶
type Money struct { // The three-letter currency code defined in ISO 4217. CurrencyCode string `protobuf:"bytes,1,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"` // The whole units of the amount. // For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. Units int64 `protobuf:"varint,2,opt,name=units,proto3" json:"units,omitempty"` // Number of nano (10^-9) units of the amount. // The value must be between -999,999,999 and +999,999,999 inclusive. // If `units` is positive, `nanos` must be positive or zero. // If `units` is zero, `nanos` can be positive, zero, or negative. // If `units` is negative, `nanos` must be negative or zero. // For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. Nanos int32 `protobuf:"varint,3,opt,name=nanos,proto3" json:"nanos,omitempty"` // contains filtered or unexported fields }
Represents an amount of money with its currency type.
func (*Money) CloneMessageVT ¶
func (*Money) Descriptor
deprecated
func (*Money) GetCurrencyCode ¶
func (*Money) MarshalToSizedBufferVT ¶
func (*Money) ProtoMessage ¶
func (*Money) ProtoMessage()
func (*Money) ProtoReflect ¶
func (x *Money) ProtoReflect() protoreflect.Message
func (*Money) UnmarshalVT ¶
func (*Money) Validate ¶
Validate checks the field values on Money with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Money) ValidateAll ¶
ValidateAll checks the field values on Money with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in MoneyMultiError, or nil if none found.
type MoneyMultiError ¶
type MoneyMultiError []error
MoneyMultiError is an error wrapping multiple validation errors returned by Money.ValidateAll() if the designated constraints aren't met.
func (MoneyMultiError) AllErrors ¶
func (m MoneyMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (MoneyMultiError) Error ¶
func (m MoneyMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type MoneyValidationError ¶
type MoneyValidationError struct {
// contains filtered or unexported fields
}
MoneyValidationError is the validation error returned by Money.Validate if the designated constraints aren't met.
func (MoneyValidationError) Cause ¶
func (e MoneyValidationError) Cause() error
Cause function returns cause value.
func (MoneyValidationError) Error ¶
func (e MoneyValidationError) Error() string
Error satisfies the builtin error interface
func (MoneyValidationError) ErrorName ¶
func (e MoneyValidationError) ErrorName() string
ErrorName returns error name.
func (MoneyValidationError) Field ¶
func (e MoneyValidationError) Field() string
Field function returns field value.
func (MoneyValidationError) Key ¶
func (e MoneyValidationError) Key() bool
Key function returns key value.
func (MoneyValidationError) Reason ¶
func (e MoneyValidationError) Reason() string
Reason function returns reason value.
type Month ¶
type Month int32
Represents a month in the Gregorian calendar.
const ( // The unspecified month. Month_MONTH_UNSPECIFIED Month = 0 // The month of January. Month_JANUARY Month = 1 // The month of February. Month_FEBRUARY Month = 2 // The month of March. Month_MARCH Month = 3 // The month of April. Month_APRIL Month = 4 // The month of May. Month_MAY Month = 5 // The month of June. Month_JUNE Month = 6 // The month of July. Month_JULY Month = 7 // The month of August. Month_AUGUST Month = 8 // The month of September. Month_SEPTEMBER Month = 9 // The month of October. Month_OCTOBER Month = 10 // The month of November. Month_NOVEMBER Month = 11 // The month of December. Month_DECEMBER Month = 12 )
func (Month) Descriptor ¶
func (Month) Descriptor() protoreflect.EnumDescriptor
func (Month) EnumDescriptor
deprecated
func (Month) Number ¶
func (x Month) Number() protoreflect.EnumNumber
func (Month) Type ¶
func (Month) Type() protoreflect.EnumType
type PhoneNumber ¶
type PhoneNumber struct { // Required. Either a regular number, or a short code. New fields may be // added to the oneof below in the future, so clients should ignore phone // numbers for which none of the fields they coded against are set. // // Types that are assignable to Kind: // // *PhoneNumber_E164Number // *PhoneNumber_ShortCode_ Kind isPhoneNumber_Kind `protobuf_oneof:"kind"` // The phone number's extension. The extension is not standardized in ITU // recommendations, except for being defined as a series of numbers with a // maximum length of 40 digits. Other than digits, some other dialing // characters such as ',' (indicating a wait) or '#' may be stored here. // // Note that no regions currently use extensions with short codes, so this // field is normally only set in conjunction with an E.164 number. It is held // separately from the E.164 number to allow for short code extensions in the // future. Extension string `protobuf:"bytes,3,opt,name=extension,proto3" json:"extension,omitempty"` // contains filtered or unexported fields }
An object representing a phone number, suitable as an API wire format.
This representation:
should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123"
is not designed for efficient storage
may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose
To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first.
For instance, in Java this would be:
com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber
func (*PhoneNumber) CloneMessageVT ¶
func (m *PhoneNumber) CloneMessageVT() proto.Message
func (*PhoneNumber) CloneVT ¶
func (m *PhoneNumber) CloneVT() *PhoneNumber
func (*PhoneNumber) Descriptor
deprecated
func (*PhoneNumber) Descriptor() ([]byte, []int)
Deprecated: Use PhoneNumber.ProtoReflect.Descriptor instead.
func (*PhoneNumber) EqualMessageVT ¶
func (this *PhoneNumber) EqualMessageVT(thatMsg proto.Message) bool
func (*PhoneNumber) EqualVT ¶
func (this *PhoneNumber) EqualVT(that *PhoneNumber) bool
func (*PhoneNumber) GetE164Number ¶
func (x *PhoneNumber) GetE164Number() string
func (*PhoneNumber) GetExtension ¶
func (x *PhoneNumber) GetExtension() string
func (*PhoneNumber) GetKind ¶
func (m *PhoneNumber) GetKind() isPhoneNumber_Kind
func (*PhoneNumber) GetShortCode ¶
func (x *PhoneNumber) GetShortCode() *PhoneNumber_ShortCode
func (*PhoneNumber) MarshalToSizedBufferVT ¶
func (m *PhoneNumber) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*PhoneNumber) MarshalToVT ¶
func (m *PhoneNumber) MarshalToVT(dAtA []byte) (int, error)
func (*PhoneNumber) MarshalVT ¶
func (m *PhoneNumber) MarshalVT() (dAtA []byte, err error)
func (*PhoneNumber) ProtoMessage ¶
func (*PhoneNumber) ProtoMessage()
func (*PhoneNumber) ProtoReflect ¶
func (x *PhoneNumber) ProtoReflect() protoreflect.Message
func (*PhoneNumber) Reset ¶
func (x *PhoneNumber) Reset()
func (*PhoneNumber) SizeVT ¶
func (m *PhoneNumber) SizeVT() (n int)
func (*PhoneNumber) String ¶
func (x *PhoneNumber) String() string
func (*PhoneNumber) UnmarshalVT ¶
func (m *PhoneNumber) UnmarshalVT(dAtA []byte) error
func (*PhoneNumber) Validate ¶
func (m *PhoneNumber) Validate() error
Validate checks the field values on PhoneNumber with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PhoneNumber) ValidateAll ¶
func (m *PhoneNumber) ValidateAll() error
ValidateAll checks the field values on PhoneNumber with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PhoneNumberMultiError, or nil if none found.
type PhoneNumberMultiError ¶
type PhoneNumberMultiError []error
PhoneNumberMultiError is an error wrapping multiple validation errors returned by PhoneNumber.ValidateAll() if the designated constraints aren't met.
func (PhoneNumberMultiError) AllErrors ¶
func (m PhoneNumberMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PhoneNumberMultiError) Error ¶
func (m PhoneNumberMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PhoneNumberValidationError ¶
type PhoneNumberValidationError struct {
// contains filtered or unexported fields
}
PhoneNumberValidationError is the validation error returned by PhoneNumber.Validate if the designated constraints aren't met.
func (PhoneNumberValidationError) Cause ¶
func (e PhoneNumberValidationError) Cause() error
Cause function returns cause value.
func (PhoneNumberValidationError) Error ¶
func (e PhoneNumberValidationError) Error() string
Error satisfies the builtin error interface
func (PhoneNumberValidationError) ErrorName ¶
func (e PhoneNumberValidationError) ErrorName() string
ErrorName returns error name.
func (PhoneNumberValidationError) Field ¶
func (e PhoneNumberValidationError) Field() string
Field function returns field value.
func (PhoneNumberValidationError) Key ¶
func (e PhoneNumberValidationError) Key() bool
Key function returns key value.
func (PhoneNumberValidationError) Reason ¶
func (e PhoneNumberValidationError) Reason() string
Reason function returns reason value.
type PhoneNumber_E164Number ¶
type PhoneNumber_E164Number struct { // The phone number, represented as a leading plus sign ('+'), followed by a // phone number that uses a relaxed ITU E.164 format consisting of the // country calling code (1 to 3 digits) and the subscriber number, with no // additional spaces or formatting, e.g.: // - correct: "+15552220123" // - incorrect: "+1 (555) 222-01234 x123". // // The ITU E.164 format limits the latter to 12 digits, but in practice not // all countries respect that, so we relax that restriction here. // National-only numbers are not allowed. // // References: // - https://www.itu.int/rec/T-REC-E.164-201011-I // - https://en.wikipedia.org/wiki/E.164. // - https://en.wikipedia.org/wiki/List_of_country_calling_codes E164Number string `protobuf:"bytes,1,opt,name=e164_number,json=e164Number,proto3,oneof"` }
func (*PhoneNumber_E164Number) CloneVT ¶
func (m *PhoneNumber_E164Number) CloneVT() isPhoneNumber_Kind
func (*PhoneNumber_E164Number) EqualVT ¶
func (this *PhoneNumber_E164Number) EqualVT(thatIface isPhoneNumber_Kind) bool
func (*PhoneNumber_E164Number) MarshalToSizedBufferVT ¶
func (m *PhoneNumber_E164Number) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*PhoneNumber_E164Number) MarshalToVT ¶
func (m *PhoneNumber_E164Number) MarshalToVT(dAtA []byte) (int, error)
func (*PhoneNumber_E164Number) SizeVT ¶
func (m *PhoneNumber_E164Number) SizeVT() (n int)
type PhoneNumber_ShortCode ¶
type PhoneNumber_ShortCode struct { // Required. The BCP-47 region code of the location where calls to this // short code can be made, such as "US" and "BB". // // Reference(s): // - http://www.unicode.org/reports/tr35/#unicode_region_subtag RegionCode string `protobuf:"bytes,1,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"` // Required. The short code digits, without a leading plus ('+') or country // calling code, e.g. "611". Number string `protobuf:"bytes,2,opt,name=number,proto3" json:"number,omitempty"` // contains filtered or unexported fields }
An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA).
func (*PhoneNumber_ShortCode) CloneMessageVT ¶
func (m *PhoneNumber_ShortCode) CloneMessageVT() proto.Message
func (*PhoneNumber_ShortCode) CloneVT ¶
func (m *PhoneNumber_ShortCode) CloneVT() *PhoneNumber_ShortCode
func (*PhoneNumber_ShortCode) Descriptor
deprecated
func (*PhoneNumber_ShortCode) Descriptor() ([]byte, []int)
Deprecated: Use PhoneNumber_ShortCode.ProtoReflect.Descriptor instead.
func (*PhoneNumber_ShortCode) EqualMessageVT ¶
func (this *PhoneNumber_ShortCode) EqualMessageVT(thatMsg proto.Message) bool
func (*PhoneNumber_ShortCode) EqualVT ¶
func (this *PhoneNumber_ShortCode) EqualVT(that *PhoneNumber_ShortCode) bool
func (*PhoneNumber_ShortCode) GetNumber ¶
func (x *PhoneNumber_ShortCode) GetNumber() string
func (*PhoneNumber_ShortCode) GetRegionCode ¶
func (x *PhoneNumber_ShortCode) GetRegionCode() string
func (*PhoneNumber_ShortCode) MarshalToSizedBufferVT ¶
func (m *PhoneNumber_ShortCode) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*PhoneNumber_ShortCode) MarshalToVT ¶
func (m *PhoneNumber_ShortCode) MarshalToVT(dAtA []byte) (int, error)
func (*PhoneNumber_ShortCode) MarshalVT ¶
func (m *PhoneNumber_ShortCode) MarshalVT() (dAtA []byte, err error)
func (*PhoneNumber_ShortCode) ProtoMessage ¶
func (*PhoneNumber_ShortCode) ProtoMessage()
func (*PhoneNumber_ShortCode) ProtoReflect ¶
func (x *PhoneNumber_ShortCode) ProtoReflect() protoreflect.Message
func (*PhoneNumber_ShortCode) Reset ¶
func (x *PhoneNumber_ShortCode) Reset()
func (*PhoneNumber_ShortCode) SizeVT ¶
func (m *PhoneNumber_ShortCode) SizeVT() (n int)
func (*PhoneNumber_ShortCode) String ¶
func (x *PhoneNumber_ShortCode) String() string
func (*PhoneNumber_ShortCode) UnmarshalVT ¶
func (m *PhoneNumber_ShortCode) UnmarshalVT(dAtA []byte) error
func (*PhoneNumber_ShortCode) Validate ¶
func (m *PhoneNumber_ShortCode) Validate() error
Validate checks the field values on PhoneNumber_ShortCode with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PhoneNumber_ShortCode) ValidateAll ¶
func (m *PhoneNumber_ShortCode) ValidateAll() error
ValidateAll checks the field values on PhoneNumber_ShortCode with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PhoneNumber_ShortCodeMultiError, or nil if none found.
type PhoneNumber_ShortCodeMultiError ¶
type PhoneNumber_ShortCodeMultiError []error
PhoneNumber_ShortCodeMultiError is an error wrapping multiple validation errors returned by PhoneNumber_ShortCode.ValidateAll() if the designated constraints aren't met.
func (PhoneNumber_ShortCodeMultiError) AllErrors ¶
func (m PhoneNumber_ShortCodeMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PhoneNumber_ShortCodeMultiError) Error ¶
func (m PhoneNumber_ShortCodeMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PhoneNumber_ShortCodeValidationError ¶
type PhoneNumber_ShortCodeValidationError struct {
// contains filtered or unexported fields
}
PhoneNumber_ShortCodeValidationError is the validation error returned by PhoneNumber_ShortCode.Validate if the designated constraints aren't met.
func (PhoneNumber_ShortCodeValidationError) Cause ¶
func (e PhoneNumber_ShortCodeValidationError) Cause() error
Cause function returns cause value.
func (PhoneNumber_ShortCodeValidationError) Error ¶
func (e PhoneNumber_ShortCodeValidationError) Error() string
Error satisfies the builtin error interface
func (PhoneNumber_ShortCodeValidationError) ErrorName ¶
func (e PhoneNumber_ShortCodeValidationError) ErrorName() string
ErrorName returns error name.
func (PhoneNumber_ShortCodeValidationError) Field ¶
func (e PhoneNumber_ShortCodeValidationError) Field() string
Field function returns field value.
func (PhoneNumber_ShortCodeValidationError) Key ¶
func (e PhoneNumber_ShortCodeValidationError) Key() bool
Key function returns key value.
func (PhoneNumber_ShortCodeValidationError) Reason ¶
func (e PhoneNumber_ShortCodeValidationError) Reason() string
Reason function returns reason value.
type PhoneNumber_ShortCode_ ¶
type PhoneNumber_ShortCode_ struct { // A short code. // // Reference(s): // - https://en.wikipedia.org/wiki/Short_code ShortCode *PhoneNumber_ShortCode `protobuf:"bytes,2,opt,name=short_code,json=shortCode,proto3,oneof"` }
func (*PhoneNumber_ShortCode_) CloneVT ¶
func (m *PhoneNumber_ShortCode_) CloneVT() isPhoneNumber_Kind
func (*PhoneNumber_ShortCode_) EqualVT ¶
func (this *PhoneNumber_ShortCode_) EqualVT(thatIface isPhoneNumber_Kind) bool
func (*PhoneNumber_ShortCode_) MarshalToSizedBufferVT ¶
func (m *PhoneNumber_ShortCode_) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*PhoneNumber_ShortCode_) MarshalToVT ¶
func (m *PhoneNumber_ShortCode_) MarshalToVT(dAtA []byte) (int, error)
func (*PhoneNumber_ShortCode_) SizeVT ¶
func (m *PhoneNumber_ShortCode_) SizeVT() (n int)
type PostalAddress ¶
type PostalAddress struct { // The schema revision of the `PostalAddress`. This must be set to 0, which is // the latest revision. // // All new revisions **must** be backward compatible with old revisions. Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"` // Required. CLDR region code of the country/region of the address. This // is never inferred and it is up to the user to ensure the value is // correct. See http://cldr.unicode.org/ and // http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html // for details. Example: "CH" for Switzerland. RegionCode string `protobuf:"bytes,2,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"` // Optional. BCP-47 language code of the contents of this address (if // known). This is often the UI language of the input form or is expected // to match one of the languages used in the address' country/region, or their // transliterated equivalents. // This can affect formatting in certain countries, but is not critical // to the correctness of the data and will never affect any validation or // other non-formatting related operations. // // If this value is not known, it should be omitted (rather than specifying a // possibly incorrect default). // // Examples: "zh-Hant", "ja", "ja-Latn", "en". LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"` // Optional. Postal code of the address. Not all countries use or require // postal codes to be present, but where they are used, they may trigger // additional validation with other parts of the address (e.g. state/zip // validation in the U.S.A.). PostalCode string `protobuf:"bytes,4,opt,name=postal_code,json=postalCode,proto3" json:"postal_code,omitempty"` // Optional. Additional, country-specific, sorting code. This is not used // in most regions. Where it is used, the value is either a string like // "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number // alone, representing the "sector code" (Jamaica), "delivery area indicator" // (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). SortingCode string `protobuf:"bytes,5,opt,name=sorting_code,json=sortingCode,proto3" json:"sorting_code,omitempty"` // Optional. Highest administrative subdivision which is used for postal // addresses of a country or region. // For example, this can be a state, a province, an oblast, or a prefecture. // Specifically, for Spain this is the province and not the autonomous // community (e.g. "Barcelona" and not "Catalonia"). // Many countries don't use an administrative area in postal addresses. E.g. // in Switzerland this should be left unpopulated. AdministrativeArea string `protobuf:"bytes,6,opt,name=administrative_area,json=administrativeArea,proto3" json:"administrative_area,omitempty"` // Optional. Generally refers to the city/town portion of the address. // Examples: US city, IT comune, UK post town. // In regions of the world where localities are not well defined or do not fit // into this structure well, leave locality empty and use address_lines. Locality string `protobuf:"bytes,7,opt,name=locality,proto3" json:"locality,omitempty"` // Optional. Sublocality of the address. // For example, this can be neighborhoods, boroughs, districts. Sublocality string `protobuf:"bytes,8,opt,name=sublocality,proto3" json:"sublocality,omitempty"` // Unstructured address lines describing the lower levels of an address. // // Because values in address_lines do not have type information and may // sometimes contain multiple values in a single field (e.g. // "Austin, TX"), it is important that the line order is clear. The order of // address lines should be "envelope order" for the country/region of the // address. In places where this can vary (e.g. Japan), address_language is // used to make it explicit (e.g. "ja" for large-to-small ordering and // "ja-Latn" or "en" for small-to-large). This way, the most specific line of // an address can be selected based on the language. // // The minimum permitted structural representation of an address consists // of a region_code with all remaining information placed in the // address_lines. It would be possible to format such an address very // approximately without geocoding, but no semantic reasoning could be // made about any of the address components until it was at least // partially resolved. // // Creating an address only containing a region_code and address_lines, and // then geocoding is the recommended way to handle completely unstructured // addresses (as opposed to guessing which parts of the address should be // localities or administrative areas). AddressLines []string `protobuf:"bytes,9,rep,name=address_lines,json=addressLines,proto3" json:"address_lines,omitempty"` // Optional. The recipient at the address. // This field may, under certain circumstances, contain multiline information. // For example, it might contain "care of" information. Recipients []string `protobuf:"bytes,10,rep,name=recipients,proto3" json:"recipients,omitempty"` // Optional. The name of the organization at the address. Organization string `protobuf:"bytes,11,opt,name=organization,proto3" json:"organization,omitempty"` // contains filtered or unexported fields }
Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).
In typical usage an address would be created via user input or from importing existing data, depending on the type of process.
Advice on address input / editing:
- Use an i18n-ready address widget such as https://github.com/google/libaddressinput)
- Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.
For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
func (*PostalAddress) CloneMessageVT ¶
func (m *PostalAddress) CloneMessageVT() proto.Message
func (*PostalAddress) CloneVT ¶
func (m *PostalAddress) CloneVT() *PostalAddress
func (*PostalAddress) Descriptor
deprecated
func (*PostalAddress) Descriptor() ([]byte, []int)
Deprecated: Use PostalAddress.ProtoReflect.Descriptor instead.
func (*PostalAddress) EqualMessageVT ¶
func (this *PostalAddress) EqualMessageVT(thatMsg proto.Message) bool
func (*PostalAddress) EqualVT ¶
func (this *PostalAddress) EqualVT(that *PostalAddress) bool
func (*PostalAddress) GetAddressLines ¶
func (x *PostalAddress) GetAddressLines() []string
func (*PostalAddress) GetAdministrativeArea ¶
func (x *PostalAddress) GetAdministrativeArea() string
func (*PostalAddress) GetLanguageCode ¶
func (x *PostalAddress) GetLanguageCode() string
func (*PostalAddress) GetLocality ¶
func (x *PostalAddress) GetLocality() string
func (*PostalAddress) GetOrganization ¶
func (x *PostalAddress) GetOrganization() string
func (*PostalAddress) GetPostalCode ¶
func (x *PostalAddress) GetPostalCode() string
func (*PostalAddress) GetRecipients ¶
func (x *PostalAddress) GetRecipients() []string
func (*PostalAddress) GetRegionCode ¶
func (x *PostalAddress) GetRegionCode() string
func (*PostalAddress) GetRevision ¶
func (x *PostalAddress) GetRevision() int32
func (*PostalAddress) GetSortingCode ¶
func (x *PostalAddress) GetSortingCode() string
func (*PostalAddress) GetSublocality ¶
func (x *PostalAddress) GetSublocality() string
func (*PostalAddress) MarshalToSizedBufferVT ¶
func (m *PostalAddress) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*PostalAddress) MarshalToVT ¶
func (m *PostalAddress) MarshalToVT(dAtA []byte) (int, error)
func (*PostalAddress) MarshalVT ¶
func (m *PostalAddress) MarshalVT() (dAtA []byte, err error)
func (*PostalAddress) ProtoMessage ¶
func (*PostalAddress) ProtoMessage()
func (*PostalAddress) ProtoReflect ¶
func (x *PostalAddress) ProtoReflect() protoreflect.Message
func (*PostalAddress) Reset ¶
func (x *PostalAddress) Reset()
func (*PostalAddress) SizeVT ¶
func (m *PostalAddress) SizeVT() (n int)
func (*PostalAddress) String ¶
func (x *PostalAddress) String() string
func (*PostalAddress) UnmarshalVT ¶
func (m *PostalAddress) UnmarshalVT(dAtA []byte) error
func (*PostalAddress) Validate ¶
func (m *PostalAddress) Validate() error
Validate checks the field values on PostalAddress with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PostalAddress) ValidateAll ¶
func (m *PostalAddress) ValidateAll() error
ValidateAll checks the field values on PostalAddress with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PostalAddressMultiError, or nil if none found.
type PostalAddressMultiError ¶
type PostalAddressMultiError []error
PostalAddressMultiError is an error wrapping multiple validation errors returned by PostalAddress.ValidateAll() if the designated constraints aren't met.
func (PostalAddressMultiError) AllErrors ¶
func (m PostalAddressMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PostalAddressMultiError) Error ¶
func (m PostalAddressMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PostalAddressValidationError ¶
type PostalAddressValidationError struct {
// contains filtered or unexported fields
}
PostalAddressValidationError is the validation error returned by PostalAddress.Validate if the designated constraints aren't met.
func (PostalAddressValidationError) Cause ¶
func (e PostalAddressValidationError) Cause() error
Cause function returns cause value.
func (PostalAddressValidationError) Error ¶
func (e PostalAddressValidationError) Error() string
Error satisfies the builtin error interface
func (PostalAddressValidationError) ErrorName ¶
func (e PostalAddressValidationError) ErrorName() string
ErrorName returns error name.
func (PostalAddressValidationError) Field ¶
func (e PostalAddressValidationError) Field() string
Field function returns field value.
func (PostalAddressValidationError) Key ¶
func (e PostalAddressValidationError) Key() bool
Key function returns key value.
func (PostalAddressValidationError) Reason ¶
func (e PostalAddressValidationError) Reason() string
Reason function returns reason value.
type Quaternion ¶
type Quaternion struct { // The x component. X float64 `protobuf:"fixed64,1,opt,name=x,proto3" json:"x,omitempty"` // The y component. Y float64 `protobuf:"fixed64,2,opt,name=y,proto3" json:"y,omitempty"` // The z component. Z float64 `protobuf:"fixed64,3,opt,name=z,proto3" json:"z,omitempty"` // The scalar component. W float64 `protobuf:"fixed64,4,opt,name=w,proto3" json:"w,omitempty"` // contains filtered or unexported fields }
A quaternion is defined as the quotient of two directed lines in a three-dimensional space or equivalently as the quotient of two Euclidean vectors (https://en.wikipedia.org/wiki/Quaternion).
Quaternions are often used in calculations involving three-dimensional rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation), as they provide greater mathematical robustness by avoiding the gimbal lock problems that can be encountered when using Euler angles (https://en.wikipedia.org/wiki/Gimbal_lock).
Quaternions are generally represented in this form:
w + xi + yj + zk
where x, y, z, and w are real numbers, and i, j, and k are three imaginary numbers.
Our naming choice `(x, y, z, w)` comes from the desire to avoid confusion for those interested in the geometric properties of the quaternion in the 3D Cartesian space. Other texts often use alternative names or subscripts, such as `(a, b, c, d)`, `(1, i, j, k)`, or `(0, 1, 2, 3)`, which are perhaps better suited for mathematical interpretations.
To avoid any confusion, as well as to maintain compatibility with a large number of software libraries, the quaternions represented using the protocol buffer below *must* follow the Hamilton convention, which defines `ij = k` (i.e. a right-handed algebra), and therefore:
i^2 = j^2 = k^2 = ijk = −1 ij = −ji = k jk = −kj = i ki = −ik = j
Please DO NOT use this to represent quaternions that follow the JPL convention, or any of the other quaternion flavors out there.
Definitions:
- Quaternion norm (or magnitude): `sqrt(x^2 + y^2 + z^2 + w^2)`.
- Unit (or normalized) quaternion: a quaternion whose norm is 1.
- Pure quaternion: a quaternion whose scalar component (`w`) is 0.
- Rotation quaternion: a unit quaternion used to represent rotation.
- Orientation quaternion: a unit quaternion used to represent orientation.
A quaternion can be normalized by dividing it by its norm. The resulting quaternion maintains the same direction, but has a norm of 1, i.e. it moves on the unit sphere. This is generally necessary for rotation and orientation quaternions, to avoid rounding errors: https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions
Note that `(x, y, z, w)` and `(-x, -y, -z, -w)` represent the same rotation, but normalization would be even more useful, e.g. for comparison purposes, if it would produce a unique representation. It is thus recommended that `w` be kept positive, which can be achieved by changing all the signs when `w` is negative.
func (*Quaternion) CloneMessageVT ¶
func (m *Quaternion) CloneMessageVT() proto.Message
func (*Quaternion) CloneVT ¶
func (m *Quaternion) CloneVT() *Quaternion
func (*Quaternion) Descriptor
deprecated
func (*Quaternion) Descriptor() ([]byte, []int)
Deprecated: Use Quaternion.ProtoReflect.Descriptor instead.
func (*Quaternion) EqualMessageVT ¶
func (this *Quaternion) EqualMessageVT(thatMsg proto.Message) bool
func (*Quaternion) EqualVT ¶
func (this *Quaternion) EqualVT(that *Quaternion) bool
func (*Quaternion) GetW ¶
func (x *Quaternion) GetW() float64
func (*Quaternion) GetX ¶
func (x *Quaternion) GetX() float64
func (*Quaternion) GetY ¶
func (x *Quaternion) GetY() float64
func (*Quaternion) GetZ ¶
func (x *Quaternion) GetZ() float64
func (*Quaternion) MarshalToSizedBufferVT ¶
func (m *Quaternion) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*Quaternion) MarshalToVT ¶
func (m *Quaternion) MarshalToVT(dAtA []byte) (int, error)
func (*Quaternion) MarshalVT ¶
func (m *Quaternion) MarshalVT() (dAtA []byte, err error)
func (*Quaternion) ProtoMessage ¶
func (*Quaternion) ProtoMessage()
func (*Quaternion) ProtoReflect ¶
func (x *Quaternion) ProtoReflect() protoreflect.Message
func (*Quaternion) Reset ¶
func (x *Quaternion) Reset()
func (*Quaternion) SizeVT ¶
func (m *Quaternion) SizeVT() (n int)
func (*Quaternion) String ¶
func (x *Quaternion) String() string
func (*Quaternion) UnmarshalVT ¶
func (m *Quaternion) UnmarshalVT(dAtA []byte) error
func (*Quaternion) Validate ¶
func (m *Quaternion) Validate() error
Validate checks the field values on Quaternion with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*Quaternion) ValidateAll ¶
func (m *Quaternion) ValidateAll() error
ValidateAll checks the field values on Quaternion with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in QuaternionMultiError, or nil if none found.
type QuaternionMultiError ¶
type QuaternionMultiError []error
QuaternionMultiError is an error wrapping multiple validation errors returned by Quaternion.ValidateAll() if the designated constraints aren't met.
func (QuaternionMultiError) AllErrors ¶
func (m QuaternionMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (QuaternionMultiError) Error ¶
func (m QuaternionMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type QuaternionValidationError ¶
type QuaternionValidationError struct {
// contains filtered or unexported fields
}
QuaternionValidationError is the validation error returned by Quaternion.Validate if the designated constraints aren't met.
func (QuaternionValidationError) Cause ¶
func (e QuaternionValidationError) Cause() error
Cause function returns cause value.
func (QuaternionValidationError) Error ¶
func (e QuaternionValidationError) Error() string
Error satisfies the builtin error interface
func (QuaternionValidationError) ErrorName ¶
func (e QuaternionValidationError) ErrorName() string
ErrorName returns error name.
func (QuaternionValidationError) Field ¶
func (e QuaternionValidationError) Field() string
Field function returns field value.
func (QuaternionValidationError) Key ¶
func (e QuaternionValidationError) Key() bool
Key function returns key value.
func (QuaternionValidationError) Reason ¶
func (e QuaternionValidationError) Reason() string
Reason function returns reason value.
type TimeOfDay ¶
type TimeOfDay struct { // Hours of day in 24 hour format. Should be from 0 to 23. An API may choose // to allow the value "24:00:00" for scenarios like business closing time. Hours int32 `protobuf:"varint,1,opt,name=hours,proto3" json:"hours,omitempty"` // Minutes of hour of day. Must be from 0 to 59. Minutes int32 `protobuf:"varint,2,opt,name=minutes,proto3" json:"minutes,omitempty"` // Seconds of minutes of the time. Must normally be from 0 to 59. An API may // allow the value 60 if it allows leap-seconds. Seconds int32 `protobuf:"varint,3,opt,name=seconds,proto3" json:"seconds,omitempty"` // Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. Nanos int32 `protobuf:"varint,4,opt,name=nanos,proto3" json:"nanos,omitempty"` // contains filtered or unexported fields }
Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and `google.protobuf.Timestamp`.
func (*TimeOfDay) CloneMessageVT ¶
func (*TimeOfDay) Descriptor
deprecated
func (*TimeOfDay) EqualMessageVT ¶
func (*TimeOfDay) GetMinutes ¶
func (*TimeOfDay) GetSeconds ¶
func (*TimeOfDay) MarshalToSizedBufferVT ¶
func (*TimeOfDay) ProtoMessage ¶
func (*TimeOfDay) ProtoMessage()
func (*TimeOfDay) ProtoReflect ¶
func (x *TimeOfDay) ProtoReflect() protoreflect.Message
func (*TimeOfDay) UnmarshalVT ¶
func (*TimeOfDay) Validate ¶
Validate checks the field values on TimeOfDay with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*TimeOfDay) ValidateAll ¶
ValidateAll checks the field values on TimeOfDay with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TimeOfDayMultiError, or nil if none found.
type TimeOfDayMultiError ¶
type TimeOfDayMultiError []error
TimeOfDayMultiError is an error wrapping multiple validation errors returned by TimeOfDay.ValidateAll() if the designated constraints aren't met.
func (TimeOfDayMultiError) AllErrors ¶
func (m TimeOfDayMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (TimeOfDayMultiError) Error ¶
func (m TimeOfDayMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type TimeOfDayValidationError ¶
type TimeOfDayValidationError struct {
// contains filtered or unexported fields
}
TimeOfDayValidationError is the validation error returned by TimeOfDay.Validate if the designated constraints aren't met.
func (TimeOfDayValidationError) Cause ¶
func (e TimeOfDayValidationError) Cause() error
Cause function returns cause value.
func (TimeOfDayValidationError) Error ¶
func (e TimeOfDayValidationError) Error() string
Error satisfies the builtin error interface
func (TimeOfDayValidationError) ErrorName ¶
func (e TimeOfDayValidationError) ErrorName() string
ErrorName returns error name.
func (TimeOfDayValidationError) Field ¶
func (e TimeOfDayValidationError) Field() string
Field function returns field value.
func (TimeOfDayValidationError) Key ¶
func (e TimeOfDayValidationError) Key() bool
Key function returns key value.
func (TimeOfDayValidationError) Reason ¶
func (e TimeOfDayValidationError) Reason() string
Reason function returns reason value.
type TimeZone ¶
type TimeZone struct { // IANA Time Zone Database time zone, e.g. "America/New_York". Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Optional. IANA Time Zone Database version number, e.g. "2019a". Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` // contains filtered or unexported fields }
Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
func (*TimeZone) CloneMessageVT ¶
func (*TimeZone) Descriptor
deprecated
func (*TimeZone) GetVersion ¶
func (*TimeZone) MarshalToSizedBufferVT ¶
func (*TimeZone) ProtoMessage ¶
func (*TimeZone) ProtoMessage()
func (*TimeZone) ProtoReflect ¶
func (x *TimeZone) ProtoReflect() protoreflect.Message
func (*TimeZone) UnmarshalVT ¶
func (*TimeZone) Validate ¶
Validate checks the field values on TimeZone with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*TimeZone) ValidateAll ¶
ValidateAll checks the field values on TimeZone with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in TimeZoneMultiError, or nil if none found.
type TimeZoneMultiError ¶
type TimeZoneMultiError []error
TimeZoneMultiError is an error wrapping multiple validation errors returned by TimeZone.ValidateAll() if the designated constraints aren't met.
func (TimeZoneMultiError) AllErrors ¶
func (m TimeZoneMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (TimeZoneMultiError) Error ¶
func (m TimeZoneMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type TimeZoneValidationError ¶
type TimeZoneValidationError struct {
// contains filtered or unexported fields
}
TimeZoneValidationError is the validation error returned by TimeZone.Validate if the designated constraints aren't met.
func (TimeZoneValidationError) Cause ¶
func (e TimeZoneValidationError) Cause() error
Cause function returns cause value.
func (TimeZoneValidationError) Error ¶
func (e TimeZoneValidationError) Error() string
Error satisfies the builtin error interface
func (TimeZoneValidationError) ErrorName ¶
func (e TimeZoneValidationError) ErrorName() string
ErrorName returns error name.
func (TimeZoneValidationError) Field ¶
func (e TimeZoneValidationError) Field() string
Field function returns field value.
func (TimeZoneValidationError) Key ¶
func (e TimeZoneValidationError) Key() bool
Key function returns key value.
func (TimeZoneValidationError) Reason ¶
func (e TimeZoneValidationError) Reason() string
Reason function returns reason value.
Source Files ¶
- calendar_period.pb.go
- calendar_period.pb.validate.go
- color.pb.go
- color.pb.validate.go
- color_vtproto.pb.go
- date.pb.go
- date.pb.validate.go
- date_vtproto.pb.go
- datetime.pb.go
- datetime.pb.validate.go
- datetime_vtproto.pb.go
- dayofweek.pb.go
- dayofweek.pb.validate.go
- decimal.pb.go
- decimal.pb.validate.go
- decimal_vtproto.pb.go
- expr.pb.go
- expr.pb.validate.go
- expr_vtproto.pb.go
- fraction.pb.go
- fraction.pb.validate.go
- fraction_vtproto.pb.go
- interval.pb.go
- interval.pb.validate.go
- interval_vtproto.pb.go
- latlng.pb.go
- latlng.pb.validate.go
- latlng_vtproto.pb.go
- localized_text.pb.go
- localized_text.pb.validate.go
- localized_text_vtproto.pb.go
- money.pb.go
- money.pb.validate.go
- money_vtproto.pb.go
- month.pb.go
- month.pb.validate.go
- phone_number.pb.go
- phone_number.pb.validate.go
- phone_number_vtproto.pb.go
- postal_address.pb.go
- postal_address.pb.validate.go
- postal_address_vtproto.pb.go
- quaternion.pb.go
- quaternion.pb.validate.go
- quaternion_vtproto.pb.go
- timeofday.pb.go
- timeofday.pb.validate.go
- timeofday_vtproto.pb.go