public sealed class Date : IMessage<Date>, IEquatable<Date>, IDeepCloneable<Date>, IBufferMessage, IMessage
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
.
Namespace
Google.TypeAssembly
Google.Api.CommonProtos.dll
Constructors
Date()
public Date()
Date(Date)
public Date(Date other)
Parameter | |
---|---|
Name | Description |
other |
Date |
Fields
DayFieldNumber
public const int DayFieldNumber = 3
Field number for the "day" field.
Field Value | |
---|---|
Type | Description |
int |
MonthFieldNumber
public const int MonthFieldNumber = 2
Field number for the "month" field.
Field Value | |
---|---|
Type | Description |
int |
YearFieldNumber
public const int YearFieldNumber = 1
Field number for the "year" field.
Field Value | |
---|---|
Type | Description |
int |
Properties
Day
public int Day { get; set; }
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.
Property Value | |
---|---|
Type | Description |
int |
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value | |
---|---|
Type | Description |
MessageDescriptor |
Month
public int Month { get; set; }
Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
Property Value | |
---|---|
Type | Description |
int |
Parser
public static MessageParser<Date> Parser { get; }
Property Value | |
---|---|
Type | Description |
MessageParserDate |
Year
public int Year { get; set; }
Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
Property Value | |
---|---|
Type | Description |
int |
Methods
CalculateSize()
public int CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
Returns | |
---|---|
Type | Description |
int |
The number of bytes required to write this message to a coded output stream. |
Clone()
public Date Clone()
Creates a deep clone of this object.
Returns | |
---|---|
Type | Description |
Date |
A deep clone of this object. |
Equals(Date)
public bool Equals(Date other)
Parameter | |
---|---|
Name | Description |
other |
Date |
Returns | |
---|---|
Type | Description |
bool |
Equals(object)
public override bool Equals(object other)
Parameter | |
---|---|
Name | Description |
other |
object |
Returns | |
---|---|
Type | Description |
bool |
FromDateTime(DateTime)
public static Date FromDateTime(DateTime dateTime)
Parameter | |
---|---|
Name | Description |
dateTime |
DateTime The DateTime value being converted. |
Returns | |
---|---|
Type | Description |
Date |
The created Date. |
FromDateTimeOffset(DateTimeOffset)
public static Date FromDateTimeOffset(DateTimeOffset dateTimeOffset)
Creates a Date instance from the Date part of DateTimeOffset.
Parameter | |
---|---|
Name | Description |
dateTimeOffset |
DateTimeOffset The DateTimeOffset value being converted. |
Returns | |
---|---|
Type | Description |
Date |
The created Date. |
GetHashCode()
public override int GetHashCode()
Returns | |
---|---|
Type | Description |
int |
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
Merges the data from the specified coded input stream with the current message.
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
See the user guide for precise merge semantics.
MergeFrom(Date)
public void MergeFrom(Date other)
Merges the given message into this one.
Parameter | |
---|---|
Name | Description |
other |
Date |
See the user guide for precise merge semantics.
ToDateTime()
public DateTime ToDateTime()
Returns | |
---|---|
Type | Description |
DateTime |
The converted DateTime with time at midnight and Kind of Unspecified. |
Exceptions | |
---|---|
Type | Description |
InvalidOperationException |
Thrown when Year, Month, and/or Day are not within the valid range. |
ToDateTimeOffset()
public DateTimeOffset ToDateTimeOffset()
Converts Date to DateTimeOffset.
Returns | |
---|---|
Type | Description |
DateTimeOffset |
The converted DateTimeOffset with time at midnight, Kind of Unspecified, and an Offset of Zero. |
Exceptions | |
---|---|
Type | Description |
InvalidOperationException |
Thrown when Year, Month, and/or Day are not within the valid range. |
ToString()
public override string ToString()
Returns | |
---|---|
Type | Description |
string |
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)
Writes the data to the given coded output stream.
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream Coded output stream to write the data to. Must not be null. |