Package com.google.analytics.admin.v1alpha

Class AudienceDimensionOrMetricFilter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AudienceDimensionOrMetricFilter.Builder>
com.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.Builder
All Implemented Interfaces:
AudienceDimensionOrMetricFilterOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AudienceDimensionOrMetricFilter
public static final class AudienceDimensionOrMetricFilter.Builder extends com.google.protobuf.GeneratedMessage.Builder<AudienceDimensionOrMetricFilter.Builder> implements AudienceDimensionOrMetricFilterOrBuilder
 A specific filter for a single dimension or metric.
Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter

  • 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.Builder<AudienceDimensionOrMetricFilter.Builder>

    • clear

      public AudienceDimensionOrMetricFilter.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AudienceDimensionOrMetricFilter.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AudienceDimensionOrMetricFilter.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public AudienceDimensionOrMetricFilter.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudienceDimensionOrMetricFilter.Builder>

    • mergeFrom

      public AudienceDimensionOrMetricFilter.Builder mergeFrom(AudienceDimensionOrMetricFilter other)

    • isInitialized

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

    • mergeFrom

      public AudienceDimensionOrMetricFilter.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudienceDimensionOrMetricFilter.Builder>
      Throws:
      IOException

    • getOneFilterCase

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

    • clearOneFilter

      public AudienceDimensionOrMetricFilter.Builder clearOneFilter()

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

    • setStringFilter

      public AudienceDimensionOrMetricFilter.Builder setStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

    • setStringFilter

      public AudienceDimensionOrMetricFilter.Builder setStringFilter(AudienceDimensionOrMetricFilter.StringFilter.Builder builderForValue)
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

    • mergeStringFilter

      public AudienceDimensionOrMetricFilter.Builder mergeStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

    • clearStringFilter

      public AudienceDimensionOrMetricFilter.Builder clearStringFilter()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

    • getStringFilterBuilder

      public AudienceDimensionOrMetricFilter.StringFilter.Builder getStringFilterBuilder()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

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

    • setInListFilter

      public AudienceDimensionOrMetricFilter.Builder setInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

    • setInListFilter

      public AudienceDimensionOrMetricFilter.Builder setInListFilter(AudienceDimensionOrMetricFilter.InListFilter.Builder builderForValue)
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

    • mergeInListFilter

      public AudienceDimensionOrMetricFilter.Builder mergeInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

    • clearInListFilter

      public AudienceDimensionOrMetricFilter.Builder clearInListFilter()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

    • getInListFilterBuilder

      public AudienceDimensionOrMetricFilter.InListFilter.Builder getInListFilterBuilder()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

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

    • setNumericFilter

      public AudienceDimensionOrMetricFilter.Builder setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

    • setNumericFilter

      public AudienceDimensionOrMetricFilter.Builder setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter.Builder builderForValue)
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

    • mergeNumericFilter

      public AudienceDimensionOrMetricFilter.Builder mergeNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

    • clearNumericFilter

      public AudienceDimensionOrMetricFilter.Builder clearNumericFilter()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

    • getNumericFilterBuilder

      public AudienceDimensionOrMetricFilter.NumericFilter.Builder getNumericFilterBuilder()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

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

    • setBetweenFilter

      public AudienceDimensionOrMetricFilter.Builder setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

    • setBetweenFilter

      public AudienceDimensionOrMetricFilter.Builder setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter.Builder builderForValue)
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

    • mergeBetweenFilter

      public AudienceDimensionOrMetricFilter.Builder mergeBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

    • clearBetweenFilter

      public AudienceDimensionOrMetricFilter.Builder clearBetweenFilter()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

    • getBetweenFilterBuilder

      public AudienceDimensionOrMetricFilter.BetweenFilter.Builder getBetweenFilterBuilder()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

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

    • setFieldName

      public AudienceDimensionOrMetricFilter.Builder setFieldName(String value)
       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];
      Parameters:
      value - The fieldName to set.
      Returns:
      This builder for chaining.

    • clearFieldName

      public AudienceDimensionOrMetricFilter.Builder clearFieldName()
       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];
      Returns:
      This builder for chaining.

    • setFieldNameBytes

      public AudienceDimensionOrMetricFilter.Builder setFieldNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for fieldName to set.
      Returns:
      This builder for chaining.

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

    • setAtAnyPointInTime

      public AudienceDimensionOrMetricFilter.Builder setAtAnyPointInTime(boolean value)
       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];
      Parameters:
      value - The atAnyPointInTime to set.
      Returns:
      This builder for chaining.

    • clearAtAnyPointInTime

      public AudienceDimensionOrMetricFilter.Builder clearAtAnyPointInTime()
       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];
      Returns:
      This builder for chaining.

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

    • setInAnyNDayPeriod

      public AudienceDimensionOrMetricFilter.Builder setInAnyNDayPeriod(int value)
       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];
      Parameters:
      value - The inAnyNDayPeriod to set.
      Returns:
      This builder for chaining.

    • clearInAnyNDayPeriod

      public AudienceDimensionOrMetricFilter.Builder clearInAnyNDayPeriod()
       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];
      Returns:
      This builder for chaining.