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.



8402
8403
8404
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8402

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

Instance Attribute Details

#bold ⇒ Boolean Also known as: bold?

Corresponds to the JSON property bold

Returns:

  • (Boolean) 


8367
8368
8369
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8367

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) 


8374
8375
8376
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8374

def highlight
  @highlight
end

#italics ⇒ Boolean Also known as: italics?

Corresponds to the JSON property italics

Returns:

  • (Boolean) 


8380
8381
8382
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8380

def italics
  @italics
end

#strikethrough ⇒ Boolean Also known as: strikethrough?

Corresponds to the JSON property strikethrough

Returns:

  • (Boolean) 


8386
8387
8388
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8386

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) 


8394
8395
8396
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8394

def style
  @style
end

#underline ⇒ Boolean Also known as: underline?

Corresponds to the JSON property underline

Returns:

  • (Boolean) 


8399
8400
8401
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8399

def underline
  @underline
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8407
8408
8409
8410
8411
8412
8413
8414
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8407

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