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.



9306
9307
9308
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9306

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

Instance Attribute Details

#bold ⇒ Boolean Also known as: bold?

Corresponds to the JSON property bold

Returns:

  • (Boolean) 


9271
9272
9273
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9271

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) 


9278
9279
9280
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9278

def highlight
  @highlight
end

#italics ⇒ Boolean Also known as: italics?

Corresponds to the JSON property italics

Returns:

  • (Boolean) 


9284
9285
9286
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9284

def italics
  @italics
end

#strikethrough ⇒ Boolean Also known as: strikethrough?

Corresponds to the JSON property strikethrough

Returns:

  • (Boolean) 


9290
9291
9292
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9290

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) 


9298
9299
9300
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9298

def style
  @style
end

#underline ⇒ Boolean Also known as: underline?

Corresponds to the JSON property underline

Returns:

  • (Boolean) 


9303
9304
9305
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9303

def underline
  @underline
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9311
9312
9313
9314
9315
9316
9317
9318
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 9311

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