Package com.google.analytics.admin.v1alpha

Class AudienceDimensionOrMetricFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter
All Implemented Interfaces:
AudienceDimensionOrMetricFilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AudienceDimensionOrMetricFilter extends com.google.protobuf.GeneratedMessage implements AudienceDimensionOrMetricFilterOrBuilder
 A specific filter for a single dimension or metric.
Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter
See Also:

  • Field Details

    • 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:

    • FIELD_NAME_FIELD_NUMBER

      public static final int FIELD_NAME_FIELD_NUMBER
      See Also:

    • AT_ANY_POINT_IN_TIME_FIELD_NUMBER

      public static final int AT_ANY_POINT_IN_TIME_FIELD_NUMBER
      See Also:

    • IN_ANY_N_DAY_PERIOD_FIELD_NUMBER

      public static final int IN_ANY_N_DAY_PERIOD_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

    • getOneFilterCase

      public AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()
      Specified by:
      getOneFilterCase in interface AudienceDimensionOrMetricFilterOrBuilder

    • hasStringFilter

      public boolean hasStringFilter()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
      Specified by:
      hasStringFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      Whether the stringFilter field is set.

    • getStringFilter

      public AudienceDimensionOrMetricFilter.StringFilter getStringFilter()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
      Specified by:
      getStringFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The stringFilter.

    • getStringFilterOrBuilder

      public AudienceDimensionOrMetricFilter.StringFilterOrBuilder getStringFilterOrBuilder()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
      Specified by:
      getStringFilterOrBuilder in interface AudienceDimensionOrMetricFilterOrBuilder

    • hasInListFilter

      public boolean hasInListFilter()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;
      Specified by:
      hasInListFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      Whether the inListFilter field is set.

    • getInListFilter

      public AudienceDimensionOrMetricFilter.InListFilter getInListFilter()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;
      Specified by:
      getInListFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The inListFilter.

    • getInListFilterOrBuilder

      public AudienceDimensionOrMetricFilter.InListFilterOrBuilder getInListFilterOrBuilder()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;
      Specified by:
      getInListFilterOrBuilder in interface AudienceDimensionOrMetricFilterOrBuilder

    • hasNumericFilter

      public boolean hasNumericFilter()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
      Specified by:
      hasNumericFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      Whether the numericFilter field is set.

    • getNumericFilter

      public AudienceDimensionOrMetricFilter.NumericFilter getNumericFilter()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
      Specified by:
      getNumericFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The numericFilter.

    • getNumericFilterOrBuilder

      public AudienceDimensionOrMetricFilter.NumericFilterOrBuilder getNumericFilterOrBuilder()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
      Specified by:
      getNumericFilterOrBuilder in interface AudienceDimensionOrMetricFilterOrBuilder

    • hasBetweenFilter

      public boolean hasBetweenFilter()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;
      Specified by:
      hasBetweenFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      Whether the betweenFilter field is set.

    • getBetweenFilter

      public AudienceDimensionOrMetricFilter.BetweenFilter getBetweenFilter()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;
      Specified by:
      getBetweenFilter in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The betweenFilter.

    • getBetweenFilterOrBuilder

      public AudienceDimensionOrMetricFilter.BetweenFilterOrBuilder getBetweenFilterOrBuilder()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;
      Specified by:
      getBetweenFilterOrBuilder in interface AudienceDimensionOrMetricFilterOrBuilder

    • getFieldName

      public String getFieldName()
       Required. Immutable. The dimension name or metric name to filter. If the
 field name refers to a custom dimension or metric, a scope prefix will be
 added to the front of the custom dimensions or metric name. For more on
 scope prefixes or custom dimensions/metrics, reference the [Google
 Analytics Data API documentation]
 (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getFieldName in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The fieldName.

    • getFieldNameBytes

      public com.google.protobuf.ByteString getFieldNameBytes()
       Required. Immutable. The dimension name or metric name to filter. If the
 field name refers to a custom dimension or metric, a scope prefix will be
 added to the front of the custom dimensions or metric name. For more on
 scope prefixes or custom dimensions/metrics, reference the [Google
 Analytics Data API documentation]
 (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getFieldNameBytes in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The bytes for fieldName.

    • getAtAnyPointInTime

      public boolean getAtAnyPointInTime()
       Optional. Indicates whether this filter needs dynamic evaluation or not. If
 set to true, users join the Audience if they ever met the condition (static
 evaluation). If unset or set to false, user evaluation for an Audience is
 dynamic; users are added to an Audience when they meet the conditions and
 then removed when they no longer meet them.

 This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
      bool at_any_point_in_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAtAnyPointInTime in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The atAnyPointInTime.

    • getInAnyNDayPeriod

      public int getInAnyNDayPeriod()
       Optional. If set, specifies the time window for which to evaluate data in
 number of days. If not set, then audience data is evaluated against
 lifetime data (For example, infinite time window).

 For example, if set to 1 day, only the current day's data is evaluated. The
 reference point is the current day when at_any_point_in_time is unset or
 false.

 It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be
 greater than 60 days.
      int32 in_any_n_day_period = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getInAnyNDayPeriod in interface AudienceDimensionOrMetricFilterOrBuilder
      Returns:
      The inAnyNDayPeriod.

    • 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 AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AudienceDimensionOrMetricFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static AudienceDimensionOrMetricFilter.Builder newBuilder()

    • newBuilder

      public static AudienceDimensionOrMetricFilter.Builder newBuilder(AudienceDimensionOrMetricFilter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static AudienceDimensionOrMetricFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AudienceDimensionOrMetricFilter> parser()

    • getParserForType

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