Class: Google::Cloud::DiscoveryEngine::V1::Condition

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/control.rb

Overview

Defines circumstances to be checked before allowing a behavior

Defined Under Namespace

Classes: QueryTerm, TimeRange

Instance Attribute Summary collapse

Instance Attribute Details

#active_time_range ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::TimeRange>

Returns Range of time(s) specifying when condition is active.

Maximum of 10 time ranges.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 45

class Condition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Matcher for search request query
  # @!attribute [rw] value
  #   @return [::String]
  #     The specific query value to match against
  #
  #     Must be lowercase, must be UTF-8.
  #     Can have at most 3 space separated terms if full_match is true.
  #     Cannot be an empty string.
  #     Maximum length of 5000 characters.
  # @!attribute [rw] full_match
  #   @return [::Boolean]
  #     Whether the search query needs to exactly match the query term.
  class QueryTerm
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used for time-dependent conditions.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Start of time range.
  #
  #     Range is inclusive.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     End of time range.
  #
  #     Range is inclusive.
  #     Must be in the future.
  class TimeRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_regex ⇒ ::String

Returns Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.

Returns:

  • (::String) —

    Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 45

class Condition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Matcher for search request query
  # @!attribute [rw] value
  #   @return [::String]
  #     The specific query value to match against
  #
  #     Must be lowercase, must be UTF-8.
  #     Can have at most 3 space separated terms if full_match is true.
  #     Cannot be an empty string.
  #     Maximum length of 5000 characters.
  # @!attribute [rw] full_match
  #   @return [::Boolean]
  #     Whether the search query needs to exactly match the query term.
  class QueryTerm
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used for time-dependent conditions.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Start of time range.
  #
  #     Range is inclusive.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     End of time range.
  #
  #     Range is inclusive.
  #     Must be in the future.
  class TimeRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query_terms ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::QueryTerm>

Returns Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set.

Maximum of 10 query terms.

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 45

class Condition
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Matcher for search request query
  # @!attribute [rw] value
  #   @return [::String]
  #     The specific query value to match against
  #
  #     Must be lowercase, must be UTF-8.
  #     Can have at most 3 space separated terms if full_match is true.
  #     Cannot be an empty string.
  #     Maximum length of 5000 characters.
  # @!attribute [rw] full_match
  #   @return [::Boolean]
  #     Whether the search query needs to exactly match the query term.
  class QueryTerm
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used for time-dependent conditions.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Start of time range.
  #
  #     Range is inclusive.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     End of time range.
  #
  #     Range is inclusive.
  #     Must be in the future.
  class TimeRange
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end