Class: Google::Apis::CloudsearchV1::DateTimePicker

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DateTimePicker

Returns a new instance of DateTimePicker.



7098
7099
7100
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7098

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

Instance Attribute Details

#label ⇒ String

The label for the field, which is displayed to the user. Corresponds to the JSON property label

Returns:

  • (String) 


7061
7062
7063
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7061

def label
  @label
end

#name ⇒ String

The name of the text field which is used in FormInput, and uniquely identifies this input. Corresponds to the JSON property name

Returns:

  • (String) 


7067
7068
7069
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7067

def name
  @name
end

#on_change ⇒ Google::Apis::CloudsearchV1::FormAction

Triggered when the user clicks on the Save, or Clear button from the date / time picker dialog. Will only be triggered if the value changed as a result of the Save / Clear operation. Corresponds to the JSON property onChange

Returns:



7074
7075
7076
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7074

def on_change
  @on_change
end

#timezone_offset_date ⇒ Fixnum

The number representing the time-zone offset from UTC, in minutes. If set, the value_ms_epoch will be displayed in the specified time zone. If not set, it will use the user's timezone setting in client side. Corresponds to the JSON property timezoneOffsetDate

Returns:

  • (Fixnum) 


7081
7082
7083
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7081

def timezone_offset_date
  @timezone_offset_date
end

#type ⇒ String

The type of the DateTimePicker. Corresponds to the JSON property type

Returns:

  • (String) 


7086
7087
7088
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7086

def type
  @type
end

#value_ms_epoch ⇒ Fixnum

The value to display which can be the default value before user input or previous user input. It is represented in milliseconds (Epoch time). - For DATE_AND_TIME type, the full epoch value is used. - For DATE_ONLY type, only date of the epoch time is used. - For TIME_ONLY type, only time of the epoch time is used. For example, you can set epoch time to 3 * 60 * 60 * 1000 to represent 3am. Corresponds to the JSON property valueMsEpoch

Returns:

  • (Fixnum) 


7096
7097
7098
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7096

def value_ms_epoch
  @value_ms_epoch
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7103
7104
7105
7106
7107
7108
7109
7110
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 7103

def update!(**args)
  @label = args[:label] if args.key?(:label)
  @name = args[:name] if args.key?(:name)
  @on_change = args[:on_change] if args.key?(:on_change)
  @timezone_offset_date = args[:timezone_offset_date] if args.key?(:timezone_offset_date)
  @type = args[:type] if args.key?(:type)
  @value_ms_epoch = args[:value_ms_epoch] if args.key?(:value_ms_epoch)
end