Package com.google.cloud.retail.v2alpha

Class Condition

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.Condition
All Implemented Interfaces:
ConditionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Condition extends com.google.protobuf.GeneratedMessage 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.v2alpha.Condition
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Condition.Builder
    Metadata that is used to define a condition that triggers an action.
    static final class 
    Condition.QueryTerm
    Query terms that we want to match on.
    static interface 
    Condition.QueryTermOrBuilder
     
    static final class 
    Condition.TimeRange
    Used for time-dependent conditions.
    static interface 
    Condition.TimeRangeOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ACTIVE_TIME_RANGE_FIELD_NUMBER
     
    static final int
    PAGE_CATEGORIES_FIELD_NUMBER
     
    static final int
    QUERY_TERMS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Condition.TimeRange
    getActiveTimeRange(int index)
    Range of time(s) specifying when Condition is active.
    int
    getActiveTimeRangeCount()
    Range of time(s) specifying when Condition is active.
    List<Condition.TimeRange>
    getActiveTimeRangeList()
    Range of time(s) specifying when Condition is active.
    Condition.TimeRangeOrBuilder
    getActiveTimeRangeOrBuilder(int index)
    Range of time(s) specifying when Condition is active.
    List<? extends Condition.TimeRangeOrBuilder>
    getActiveTimeRangeOrBuilderList()
    Range of time(s) specifying when Condition is active.
    static Condition
    getDefaultInstance()
     
    Condition
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getPageCategories(int index)
    Used to support browse uses cases.
    com.google.protobuf.ByteString
    getPageCategoriesBytes(int index)
    Used to support browse uses cases.
    int
    getPageCategoriesCount()
    Used to support browse uses cases.
    com.google.protobuf.ProtocolStringList
    getPageCategoriesList()
    Used to support browse uses cases.
    com.google.protobuf.Parser<Condition>
    getParserForType()
     
    Condition.QueryTerm
    getQueryTerms(int index)
    A list (up to 10 entries) of terms to match the query on.
    int
    getQueryTermsCount()
    A list (up to 10 entries) of terms to match the query on.
    List<Condition.QueryTerm>
    getQueryTermsList()
    A list (up to 10 entries) of terms to match the query on.
    Condition.QueryTermOrBuilder
    getQueryTermsOrBuilder(int index)
    A list (up to 10 entries) of terms to match the query on.
    List<? extends Condition.QueryTermOrBuilder>
    getQueryTermsOrBuilderList()
    A list (up to 10 entries) of terms to match the query on.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Condition.Builder
    newBuilder()
     
    static Condition.Builder
    newBuilder(Condition prototype)
     
    Condition.Builder
    newBuilderForType()
     
    protected Condition.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Condition
    parseDelimitedFrom(InputStream input)
     
    static Condition
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Condition
    parseFrom(byte[] data)
     
    static Condition
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Condition
    parseFrom(com.google.protobuf.ByteString data)
     
    static Condition
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Condition
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Condition
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Condition
    parseFrom(InputStream input)
     
    static Condition
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Condition
    parseFrom(ByteBuffer data)
     
    static Condition
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Condition>
    parser()
     
    Condition.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • QUERY_TERMS_FIELD_NUMBER

      public static final int QUERY_TERMS_FIELD_NUMBER
      See Also:

    • ACTIVE_TIME_RANGE_FIELD_NUMBER

      public static final int ACTIVE_TIME_RANGE_FIELD_NUMBER
      See Also:

    • PAGE_CATEGORIES_FIELD_NUMBER

      public static final int PAGE_CATEGORIES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.Condition.TimeRange active_time_range = 3;
      Specified by:
      getActiveTimeRangeList in interface ConditionOrBuilder

    • getActiveTimeRangeOrBuilderList

      public List<? extends Condition.TimeRangeOrBuilder> getActiveTimeRangeOrBuilderList()
       Range of time(s) specifying when Condition is active.
 Condition true if any time range matches.
      repeated .google.cloud.retail.v2alpha.Condition.TimeRange active_time_range = 3;
      Specified by:
      getActiveTimeRangeOrBuilderList 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.v2alpha.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.v2alpha.Condition.TimeRange active_time_range = 3;
      Specified by:
      getActiveTimeRange in interface ConditionOrBuilder

    • getActiveTimeRangeOrBuilder

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

    • getPageCategoriesList

      public com.google.protobuf.ProtocolStringList getPageCategoriesList()
       Used to support browse uses cases.
 A list (up to 10 entries) of categories or departments.
 The format should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];
      repeated string page_categories = 4;
      Specified by:
      getPageCategoriesList in interface ConditionOrBuilder
      Returns:
      A list containing the pageCategories.

    • getPageCategoriesCount

      public int getPageCategoriesCount()
       Used to support browse uses cases.
 A list (up to 10 entries) of categories or departments.
 The format should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];
      repeated string page_categories = 4;
      Specified by:
      getPageCategoriesCount in interface ConditionOrBuilder
      Returns:
      The count of pageCategories.

    • getPageCategories

      public String getPageCategories(int index)
       Used to support browse uses cases.
 A list (up to 10 entries) of categories or departments.
 The format should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];
      repeated string page_categories = 4;
      Specified by:
      getPageCategories in interface ConditionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The pageCategories at the given index.

    • getPageCategoriesBytes

      public com.google.protobuf.ByteString getPageCategoriesBytes(int index)
       Used to support browse uses cases.
 A list (up to 10 entries) of categories or departments.
 The format should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];
      repeated string page_categories = 4;
      Specified by:
      getPageCategoriesBytes in interface ConditionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the pageCategories at the given index.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Condition parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Condition parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Condition parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Condition parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • 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

    • newBuilder

      public static Condition.Builder newBuilder()

    • newBuilder

      public static Condition.Builder newBuilder(Condition prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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