Class: Google::Apis::DiscoveryengineV1::GoogleTypeDateTime

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/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, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. 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) ⇒ GoogleTypeDateTime

Returns a new instance of GoogleTypeDateTime.



22256
22257
22258
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22256

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

Instance Attribute Details

#day ⇒ Fixnum

Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. Corresponds to the JSON property day

Returns:

  • (Fixnum) 


22206
22207
22208
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22206

def day
  @day
end

#hours ⇒ Fixnum

Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). 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) 


22213
22214
22215
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22213

def hours
  @hours
end

#minutes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


22218
22219
22220
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22218

def minutes
  @minutes
end

#month ⇒ Fixnum

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. Corresponds to the JSON property month

Returns:

  • (Fixnum) 


22224
22225
22226
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22224

def month
  @month
end

#nanos ⇒ Fixnum

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

Returns:

  • (Fixnum) 


22230
22231
22232
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22230

def nanos
  @nanos
end

#seconds ⇒ Fixnum

Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. Corresponds to the JSON property seconds

Returns:

  • (Fixnum) 


22236
22237
22238
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22236

def seconds
  @seconds
end

#time_zone ⇒ Google::Apis::DiscoveryengineV1::GoogleTypeTimeZone

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

Returns:



22242
22243
22244
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22242

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) 


22248
22249
22250
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22248

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) 


22254
22255
22256
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22254

def year
  @year
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 22261

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