Class SegmentParameterFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.SegmentParameterFilter
All Implemented Interfaces:
SegmentParameterFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class SegmentParameterFilter extends com.google.protobuf.GeneratedMessage implements SegmentParameterFilterOrBuilder
 An expression to filter parameter values in a segment.
 
Protobuf type google.analytics.data.v1alpha.SegmentParameterFilter
See Also:
  • Field Details

    • EVENT_PARAMETER_NAME_FIELD_NUMBER

      public static final int EVENT_PARAMETER_NAME_FIELD_NUMBER
      See Also:
    • ITEM_PARAMETER_NAME_FIELD_NUMBER

      public static final int ITEM_PARAMETER_NAME_FIELD_NUMBER
      See Also:
    • STRING_FILTER_FIELD_NUMBER

      public static final int STRING_FILTER_FIELD_NUMBER
      See Also:
    • IN_LIST_FILTER_FIELD_NUMBER

      public static final int IN_LIST_FILTER_FIELD_NUMBER
      See Also:
    • NUMERIC_FILTER_FIELD_NUMBER

      public static final int NUMERIC_FILTER_FIELD_NUMBER
      See Also:
    • BETWEEN_FILTER_FIELD_NUMBER

      public static final int BETWEEN_FILTER_FIELD_NUMBER
      See Also:
    • FILTER_SCOPING_FIELD_NUMBER

      public static final int FILTER_SCOPING_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
    • getOneParameterCase

      public SegmentParameterFilter.OneParameterCase getOneParameterCase()
      Specified by:
      getOneParameterCase in interface SegmentParameterFilterOrBuilder
    • getOneFilterCase

      public SegmentParameterFilter.OneFilterCase getOneFilterCase()
      Specified by:
      getOneFilterCase in interface SegmentParameterFilterOrBuilder
    • hasEventParameterName

      public boolean hasEventParameterName()
       This filter will be evaluated on the specified event parameter. Event
       parameters are logged as parameters of the event. Event parameters
       include fields like "firebase_screen" & "currency".
      
       Event parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
       
      string event_parameter_name = 1;
      Specified by:
      hasEventParameterName in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the eventParameterName field is set.
    • getEventParameterName

      public String getEventParameterName()
       This filter will be evaluated on the specified event parameter. Event
       parameters are logged as parameters of the event. Event parameters
       include fields like "firebase_screen" & "currency".
      
       Event parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
       
      string event_parameter_name = 1;
      Specified by:
      getEventParameterName in interface SegmentParameterFilterOrBuilder
      Returns:
      The eventParameterName.
    • getEventParameterNameBytes

      public com.google.protobuf.ByteString getEventParameterNameBytes()
       This filter will be evaluated on the specified event parameter. Event
       parameters are logged as parameters of the event. Event parameters
       include fields like "firebase_screen" & "currency".
      
       Event parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
       
      string event_parameter_name = 1;
      Specified by:
      getEventParameterNameBytes in interface SegmentParameterFilterOrBuilder
      Returns:
      The bytes for eventParameterName.
    • hasItemParameterName

      public boolean hasItemParameterName()
       This filter will be evaluated on the specified item parameter. Item
       parameters are logged as parameters in the item array. Item parameters
       include fields like "item_name" & "item_category".
      
       Item parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
      
       Item parameters are only available in ecommerce events. To learn more
       about ecommerce events, see the [Measure ecommerce]
       (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
       guide.
       
      string item_parameter_name = 2;
      Specified by:
      hasItemParameterName in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the itemParameterName field is set.
    • getItemParameterName

      public String getItemParameterName()
       This filter will be evaluated on the specified item parameter. Item
       parameters are logged as parameters in the item array. Item parameters
       include fields like "item_name" & "item_category".
      
       Item parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
      
       Item parameters are only available in ecommerce events. To learn more
       about ecommerce events, see the [Measure ecommerce]
       (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
       guide.
       
      string item_parameter_name = 2;
      Specified by:
      getItemParameterName in interface SegmentParameterFilterOrBuilder
      Returns:
      The itemParameterName.
    • getItemParameterNameBytes

      public com.google.protobuf.ByteString getItemParameterNameBytes()
       This filter will be evaluated on the specified item parameter. Item
       parameters are logged as parameters in the item array. Item parameters
       include fields like "item_name" & "item_category".
      
       Item parameters can only be used in segments & funnels and can only be
       used in a descendent filter from an EventFilter. In a descendent filter
       from an EventFilter either event or item parameters should be used.
      
       Item parameters are only available in ecommerce events. To learn more
       about ecommerce events, see the [Measure ecommerce]
       (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce)
       guide.
       
      string item_parameter_name = 2;
      Specified by:
      getItemParameterNameBytes in interface SegmentParameterFilterOrBuilder
      Returns:
      The bytes for itemParameterName.
    • hasStringFilter

      public boolean hasStringFilter()
       Strings related filter.
       
      .google.analytics.data.v1alpha.StringFilter string_filter = 4;
      Specified by:
      hasStringFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the stringFilter field is set.
    • getStringFilter

      public StringFilter getStringFilter()
       Strings related filter.
       
      .google.analytics.data.v1alpha.StringFilter string_filter = 4;
      Specified by:
      getStringFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      The stringFilter.
    • getStringFilterOrBuilder

      public StringFilterOrBuilder getStringFilterOrBuilder()
       Strings related filter.
       
      .google.analytics.data.v1alpha.StringFilter string_filter = 4;
      Specified by:
      getStringFilterOrBuilder in interface SegmentParameterFilterOrBuilder
    • hasInListFilter

      public boolean hasInListFilter()
       A filter for in list values.
       
      .google.analytics.data.v1alpha.InListFilter in_list_filter = 5;
      Specified by:
      hasInListFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the inListFilter field is set.
    • getInListFilter

      public InListFilter getInListFilter()
       A filter for in list values.
       
      .google.analytics.data.v1alpha.InListFilter in_list_filter = 5;
      Specified by:
      getInListFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      The inListFilter.
    • getInListFilterOrBuilder

      public InListFilterOrBuilder getInListFilterOrBuilder()
       A filter for in list values.
       
      .google.analytics.data.v1alpha.InListFilter in_list_filter = 5;
      Specified by:
      getInListFilterOrBuilder in interface SegmentParameterFilterOrBuilder
    • hasNumericFilter

      public boolean hasNumericFilter()
       A filter for numeric or date values.
       
      .google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;
      Specified by:
      hasNumericFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the numericFilter field is set.
    • getNumericFilter

      public NumericFilter getNumericFilter()
       A filter for numeric or date values.
       
      .google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;
      Specified by:
      getNumericFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      The numericFilter.
    • getNumericFilterOrBuilder

      public NumericFilterOrBuilder getNumericFilterOrBuilder()
       A filter for numeric or date values.
       
      .google.analytics.data.v1alpha.NumericFilter numeric_filter = 6;
      Specified by:
      getNumericFilterOrBuilder in interface SegmentParameterFilterOrBuilder
    • hasBetweenFilter

      public boolean hasBetweenFilter()
       A filter for between two values.
       
      .google.analytics.data.v1alpha.BetweenFilter between_filter = 7;
      Specified by:
      hasBetweenFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the betweenFilter field is set.
    • getBetweenFilter

      public BetweenFilter getBetweenFilter()
       A filter for between two values.
       
      .google.analytics.data.v1alpha.BetweenFilter between_filter = 7;
      Specified by:
      getBetweenFilter in interface SegmentParameterFilterOrBuilder
      Returns:
      The betweenFilter.
    • getBetweenFilterOrBuilder

      public BetweenFilterOrBuilder getBetweenFilterOrBuilder()
       A filter for between two values.
       
      .google.analytics.data.v1alpha.BetweenFilter between_filter = 7;
      Specified by:
      getBetweenFilterOrBuilder in interface SegmentParameterFilterOrBuilder
    • hasFilterScoping

      public boolean hasFilterScoping()
       Specifies the scope for the filter.
       
      .google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;
      Specified by:
      hasFilterScoping in interface SegmentParameterFilterOrBuilder
      Returns:
      Whether the filterScoping field is set.
    • getFilterScoping

      public SegmentParameterFilterScoping getFilterScoping()
       Specifies the scope for the filter.
       
      .google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;
      Specified by:
      getFilterScoping in interface SegmentParameterFilterOrBuilder
      Returns:
      The filterScoping.
    • getFilterScopingOrBuilder

      public SegmentParameterFilterScopingOrBuilder getFilterScopingOrBuilder()
       Specifies the scope for the filter.
       
      .google.analytics.data.v1alpha.SegmentParameterFilterScoping filter_scoping = 8;
      Specified by:
      getFilterScopingOrBuilder in interface SegmentParameterFilterOrBuilder
    • 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 SegmentParameterFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static SegmentParameterFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static SegmentParameterFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static SegmentParameterFilter.Builder newBuilder()
    • newBuilder

      public static SegmentParameterFilter.Builder newBuilder(SegmentParameterFilter prototype)
    • toBuilder

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

      protected SegmentParameterFilter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SegmentParameterFilter getDefaultInstance()
    • parser

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

      public com.google.protobuf.Parser<SegmentParameterFilter> 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 SegmentParameterFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder