_type

Documentation

Index

• Variables
• type DateTime
  • func (*DateTime) Descriptor() ([]byte, []int)
  • 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 (*DateTime) ProtoMessage()
  • func (x *DateTime) ProtoReflect() protoreflect.Message
  • func (x *DateTime) Reset()
  • func (x *DateTime) String() string
  • func (m *DateTime) Validate() error
  • func (m *DateTime) ValidateAll() error
• type DateTimeMultiError
  • func (m DateTimeMultiError) AllErrors() []error
  • func (m DateTimeMultiError) Error() string
• type DateTimeValidationError
  • func (e DateTimeValidationError) Cause() error
  • func (e DateTimeValidationError) Error() string
  • func (e DateTimeValidationError) ErrorName() string
  • func (e DateTimeValidationError) Field() string
  • func (e DateTimeValidationError) Key() bool
  • func (e DateTimeValidationError) Reason() string
• type DateTime_TimeZone
• type DateTime_UtcOffset
• type TimeZone
  • func (*TimeZone) Descriptor() ([]byte, []int)
  • func (x *TimeZone) GetId() string
  • func (x *TimeZone) GetVersion() string
  • func (*TimeZone) ProtoMessage()
  • func (x *TimeZone) ProtoReflect() protoreflect.Message
  • func (x *TimeZone) Reset()
  • func (x *TimeZone) String() string
  • func (m *TimeZone) Validate() error
  • func (m *TimeZone) ValidateAll() error
• type TimeZoneMultiError
  • func (m TimeZoneMultiError) AllErrors() []error
  • func (m TimeZoneMultiError) Error() string
• type TimeZoneValidationError
  • func (e TimeZoneValidationError) Cause() error
  • func (e TimeZoneValidationError) Error() string
  • func (e TimeZoneValidationError) ErrorName() string
  • func (e TimeZoneValidationError) Field() string
  • func (e TimeZoneValidationError) Key() bool
  • func (e TimeZoneValidationError) Reason() string

Variables

var File_google_type_datetime_proto protoreflect.FileDescriptor

Types

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) Descriptor

func (*DateTime) Descriptor() ([]byte, []int)

Deprecated: Use DateTime.ProtoReflect.Descriptor instead.

func (*DateTime) GetDay

func (x *DateTime) GetDay() int32

func (*DateTime) GetHours

func (x *DateTime) GetHours() int32

func (*DateTime) GetMinutes

func (x *DateTime) GetMinutes() int32

func (*DateTime) GetMonth

func (x *DateTime) GetMonth() int32

func (*DateTime) GetNanos

func (x *DateTime) GetNanos() int32

func (*DateTime) GetSeconds

func (x *DateTime) GetSeconds() int32

func (*DateTime) GetTimeOffset

func (m *DateTime) GetTimeOffset() isDateTime_TimeOffset

func (*DateTime) GetTimeZone

func (x *DateTime) GetTimeZone() *TimeZone

func (*DateTime) GetUtcOffset

func (x *DateTime) GetUtcOffset() *durationpb.Duration

func (*DateTime) GetYear

func (x *DateTime) GetYear() int32

func (*DateTime) ProtoMessage

func (*DateTime) ProtoMessage()

func (*DateTime) ProtoReflect

func (x *DateTime) ProtoReflect() protoreflect.Message

func (*DateTime) Reset

func (x *DateTime) Reset()

func (*DateTime) String

func (x *DateTime) String() string

func (*DateTime) Validate

func (m *DateTime) Validate() error

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

func (m *DateTime) ValidateAll() error

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"`
}

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"`
}

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) Descriptor

func (*TimeZone) Descriptor() ([]byte, []int)

Deprecated: Use TimeZone.ProtoReflect.Descriptor instead.

func (*TimeZone) GetId

func (x *TimeZone) GetId() string

func (*TimeZone) GetVersion

func (x *TimeZone) GetVersion() string

func (*TimeZone) ProtoMessage

func (*TimeZone) ProtoMessage()

func (*TimeZone) ProtoReflect

func (x *TimeZone) ProtoReflect() protoreflect.Message

func (*TimeZone) Reset

func (x *TimeZone) Reset()

func (*TimeZone) String

func (x *TimeZone) String() string

func (*TimeZone) Validate

func (m *TimeZone) Validate() error

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

func (m *TimeZone) ValidateAll() error

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.