Class: Google::Apis::DocsV1::SubstringMatchCriteria

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

Overview

A criteria that matches a specific string of text in the document.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SubstringMatchCriteria

Returns a new instance of SubstringMatchCriteria.



5203
5204
5205
# File 'lib/google/apis/docs_v1/classes.rb', line 5203

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

Instance Attribute Details

#match_caseBoolean Also known as: match_case?

Indicates whether the search should respect case: - True: the search is case sensitive. - False: the search is case insensitive. Corresponds to the JSON property matchCase

Returns:

  • (Boolean)


5186
5187
5188
# File 'lib/google/apis/docs_v1/classes.rb', line 5186

def match_case
  @match_case
end

#search_by_regexBoolean Also known as: search_by_regex?

Optional. True if the find value should be treated as a regular expression. Any backslashes in the pattern should be escaped. - True: the search text is treated as a regular expressions. - False: the search text is treated as a substring for matching. Corresponds to the JSON property searchByRegex

Returns:

  • (Boolean)


5195
5196
5197
# File 'lib/google/apis/docs_v1/classes.rb', line 5195

def search_by_regex
  @search_by_regex
end

#textString

The text to search for in the document. Corresponds to the JSON property text

Returns:

  • (String)


5201
5202
5203
# File 'lib/google/apis/docs_v1/classes.rb', line 5201

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5208
5209
5210
5211
5212
# File 'lib/google/apis/docs_v1/classes.rb', line 5208

def update!(**args)
  @match_case = args[:match_case] if args.key?(:match_case)
  @search_by_regex = args[:search_by_regex] if args.key?(:search_by_regex)
  @text = args[:text] if args.key?(:text)
end