Class Condition

  • All Implemented Interfaces:
    ConditionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Condition
    extends com.google.protobuf.GeneratedMessageV3
    implements ConditionOrBuilder
     Metadata that is used to define a condition that triggers an action.
     A valid condition must specify at least one of 'query_terms' or
     'products_filter'. If multiple fields are specified, the condition is met if
     all the fields are satisfied e.g. if a set of query terms and product_filter
     are set, then only items matching the product_filter for requests with a
     query matching the query terms wil get boosted.
     
    Protobuf type google.cloud.retail.v2beta.Condition
    See Also:
    Serialized Form
    • Field Detail

      • QUERY_TERMS_FIELD_NUMBER

        public static final int QUERY_TERMS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ACTIVE_TIME_RANGE_FIELD_NUMBER

        public static final int ACTIVE_TIME_RANGE_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getQueryTermsList

        public List<Condition.QueryTerm> getQueryTermsList()
         A list (up to 10 entries) of terms to match the query on. If not
         specified, match all queries.
         If many query terms are specified, the condition
         is matched if any of the terms is a match (i.e. using the OR operator).
         
        repeated .google.cloud.retail.v2beta.Condition.QueryTerm query_terms = 1;
        Specified by:
        getQueryTermsList in interface ConditionOrBuilder
      • getQueryTermsOrBuilderList

        public List<? extends Condition.QueryTermOrBuilder> getQueryTermsOrBuilderList()
         A list (up to 10 entries) of terms to match the query on. If not
         specified, match all queries.
         If many query terms are specified, the condition
         is matched if any of the terms is a match (i.e. using the OR operator).
         
        repeated .google.cloud.retail.v2beta.Condition.QueryTerm query_terms = 1;
        Specified by:
        getQueryTermsOrBuilderList in interface ConditionOrBuilder
      • getQueryTermsCount

        public int getQueryTermsCount()
         A list (up to 10 entries) of terms to match the query on. If not
         specified, match all queries.
         If many query terms are specified, the condition
         is matched if any of the terms is a match (i.e. using the OR operator).
         
        repeated .google.cloud.retail.v2beta.Condition.QueryTerm query_terms = 1;
        Specified by:
        getQueryTermsCount in interface ConditionOrBuilder
      • getQueryTerms

        public Condition.QueryTerm getQueryTerms​(int index)
         A list (up to 10 entries) of terms to match the query on. If not
         specified, match all queries.
         If many query terms are specified, the condition
         is matched if any of the terms is a match (i.e. using the OR operator).
         
        repeated .google.cloud.retail.v2beta.Condition.QueryTerm query_terms = 1;
        Specified by:
        getQueryTerms in interface ConditionOrBuilder
      • getQueryTermsOrBuilder

        public Condition.QueryTermOrBuilder getQueryTermsOrBuilder​(int index)
         A list (up to 10 entries) of terms to match the query on. If not
         specified, match all queries.
         If many query terms are specified, the condition
         is matched if any of the terms is a match (i.e. using the OR operator).
         
        repeated .google.cloud.retail.v2beta.Condition.QueryTerm query_terms = 1;
        Specified by:
        getQueryTermsOrBuilder in interface ConditionOrBuilder
      • getActiveTimeRangeList

        public List<Condition.TimeRange> getActiveTimeRangeList()
         Range of time(s) specifying when Condition is active.
         Condition true if any time range matches.
         
        repeated .google.cloud.retail.v2beta.Condition.TimeRange active_time_range = 3;
        Specified by:
        getActiveTimeRangeList in interface ConditionOrBuilder
      • getActiveTimeRangeCount

        public int getActiveTimeRangeCount()
         Range of time(s) specifying when Condition is active.
         Condition true if any time range matches.
         
        repeated .google.cloud.retail.v2beta.Condition.TimeRange active_time_range = 3;
        Specified by:
        getActiveTimeRangeCount in interface ConditionOrBuilder
      • getActiveTimeRange

        public Condition.TimeRange getActiveTimeRange​(int index)
         Range of time(s) specifying when Condition is active.
         Condition true if any time range matches.
         
        repeated .google.cloud.retail.v2beta.Condition.TimeRange active_time_range = 3;
        Specified by:
        getActiveTimeRange in interface ConditionOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Condition parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Condition parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Condition.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Condition.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Condition.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Condition getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Condition> parser()
      • getParserForType

        public com.google.protobuf.Parser<Condition> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Condition getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder