Class: Google::Apis::CloudsearchV1::Formatting

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

Overview

Formatting information for a segment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Formatting

Returns a new instance of Formatting.



8843
8844
8845
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8843

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

Instance Attribute Details

#bold ⇒ Boolean Also known as: bold?

Corresponds to the JSON property bold

Returns:

  • (Boolean) 


8808
8809
8810
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8808

def bold
  @bold
end

#highlight ⇒ Boolean Also known as: highlight?

This indicates that the segment should be rendered as highlighted or visually emphasized. Corresponds to the JSON property highlight

Returns:

  • (Boolean) 


8815
8816
8817
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8815

def highlight
  @highlight
end

#italics ⇒ Boolean Also known as: italics?

Corresponds to the JSON property italics

Returns:

  • (Boolean) 


8821
8822
8823
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8821

def italics
  @italics
end

#strikethrough ⇒ Boolean Also known as: strikethrough?

Corresponds to the JSON property strikethrough

Returns:

  • (Boolean) 


8827
8828
8829
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8827

def strikethrough
  @strikethrough
end

#style ⇒ String

If set, this indicates that the segment should be rendered with the specified style. The absence of an explicit style represents "no style", i.e. the segment can be rendered with the default style chosen by the application. Corresponds to the JSON property style

Returns:

  • (String) 


8835
8836
8837
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8835

def style
  @style
end

#underline ⇒ Boolean Also known as: underline?

Corresponds to the JSON property underline

Returns:

  • (Boolean) 


8840
8841
8842
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8840

def underline
  @underline
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8848
8849
8850
8851
8852
8853
8854
8855
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8848

def update!(**args)
  @bold = args[:bold] if args.key?(:bold)
  @highlight = args[:highlight] if args.key?(:highlight)
  @italics = args[:italics] if args.key?(:italics)
  @strikethrough = args[:strikethrough] if args.key?(:strikethrough)
  @style = args[:style] if args.key?(:style)
  @underline = args[:underline] if args.key?(:underline)
end