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.



8755
8756
8757
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8755

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

Instance Attribute Details

#bold ⇒ Boolean Also known as: bold?

Corresponds to the JSON property bold

Returns:

  • (Boolean) 


8720
8721
8722
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8720

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) 


8727
8728
8729
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8727

def highlight
  @highlight
end

#italics ⇒ Boolean Also known as: italics?

Corresponds to the JSON property italics

Returns:

  • (Boolean) 


8733
8734
8735
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8733

def italics
  @italics
end

#strikethrough ⇒ Boolean Also known as: strikethrough?

Corresponds to the JSON property strikethrough

Returns:

  • (Boolean) 


8739
8740
8741
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8739

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) 


8747
8748
8749
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8747

def style
  @style
end

#underline ⇒ Boolean Also known as: underline?

Corresponds to the JSON property underline

Returns:

  • (Boolean) 


8752
8753
8754
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8752

def underline
  @underline
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8760
8761
8762
8763
8764
8765
8766
8767
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8760

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