Class: Google::Apis::ComputeAlpha::DateTime

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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) ⇒ DateTime

Returns a new instance of DateTime.



11412
11413
11414
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11412

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) 


11361
11362
11363
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11361

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) 


11368
11369
11370
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11368

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) 


11373
11374
11375
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11373

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) 


11379
11380
11381
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11379

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) 


11385
11386
11387
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11385

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) 


11391
11392
11393
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11391

def seconds
  @seconds
end

#time_zone ⇒ Google::Apis::ComputeAlpha::TimeZone

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

Returns:



11397
11398
11399
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11397

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) 


11404
11405
11406
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11404

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) 


11410
11411
11412
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11410

def year
  @year
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 11417

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