Class: Google::Apis::ContentV2_1::DateTime

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DateTime

Returns a new instance of DateTime.



2971
2972
2973
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2971

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#day ⇒ Fixnum

Required. Day of month. Must be from 1 to 31 and valid for the year and month. Corresponds to the JSON property day

Returns:

  • (Fixnum) 


2924
2925
2926
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2924

def day
  @day
end

#hours ⇒ Fixnum

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. Corresponds to the JSON property hours

Returns:

  • (Fixnum) 


2930
2931
2932
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2930

def hours
  @hours
end

#minutes ⇒ Fixnum

Required. Minutes of hour of day. Must be from 0 to 59. Corresponds to the JSON property minutes

Returns:

  • (Fixnum) 


2935
2936
2937
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2935

def minutes
  @minutes
end

#month ⇒ Fixnum

Required. Month of year. Must be from 1 to 12. Corresponds to the JSON property month

Returns:

  • (Fixnum) 


2940
2941
2942
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2940

def month
  @month
end

#nanos ⇒ Fixnum

Required. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. Corresponds to the JSON property nanos

Returns:

  • (Fixnum) 


2945
2946
2947
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2945

def nanos
  @nanos
end

#seconds ⇒ Fixnum

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. Corresponds to the JSON property seconds

Returns:

  • (Fixnum) 


2951
2952
2953
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2951

def seconds
  @seconds
end

#time_zone ⇒ Google::Apis::ContentV2_1::TimeZone

Represents a time zone from the IANA Time Zone Database. Corresponds to the JSON property timeZone

Returns:



2957
2958
2959
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2957

def time_zone
  @time_zone
end

#utc_offset ⇒ String

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. Corresponds to the JSON property utcOffset

Returns:

  • (String) 


2963
2964
2965
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2963

def utc_offset
  @utc_offset
end

#year ⇒ Fixnum

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. Corresponds to the JSON property year

Returns:

  • (Fixnum) 


2969
2970
2971
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2969

def year
  @year
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2976

def update!(**args)
  @day = args[:day] if args.key?(:day)
  @hours = args[:hours] if args.key?(:hours)
  @minutes = args[:minutes] if args.key?(:minutes)
  @month = args[:month] if args.key?(:month)
  @nanos = args[:nanos] if args.key?(:nanos)
  @seconds = args[:seconds] if args.key?(:seconds)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @utc_offset = args[:utc_offset] if args.key?(:utc_offset)
  @year = args[:year] if args.key?(:year)
end