public final class AudienceDimensionOrMetricFilter extends GeneratedMessageV3 implements AudienceDimensionOrMetricFilterOrBuilder
A specific filter for a single dimension or metric.
Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter
Static Fields
AT_ANY_POINT_IN_TIME_FIELD_NUMBER
public static final int AT_ANY_POINT_IN_TIME_FIELD_NUMBER
Field Value
BETWEEN_FILTER_FIELD_NUMBER
public static final int BETWEEN_FILTER_FIELD_NUMBER
Field Value
FIELD_NAME_FIELD_NUMBER
public static final int FIELD_NAME_FIELD_NUMBER
Field Value
IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
public static final int IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
Field Value
IN_LIST_FILTER_FIELD_NUMBER
public static final int IN_LIST_FILTER_FIELD_NUMBER
Field Value
NUMERIC_FILTER_FIELD_NUMBER
public static final int NUMERIC_FILTER_FIELD_NUMBER
Field Value
STRING_FILTER_FIELD_NUMBER
public static final int STRING_FILTER_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AudienceDimensionOrMetricFilter getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AudienceDimensionOrMetricFilter.Builder newBuilder()
Returns
newBuilder(AudienceDimensionOrMetricFilter prototype)
public static AudienceDimensionOrMetricFilter.Builder newBuilder(AudienceDimensionOrMetricFilter prototype)
Parameter
Returns
public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AudienceDimensionOrMetricFilter parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AudienceDimensionOrMetricFilter parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AudienceDimensionOrMetricFilter parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AudienceDimensionOrMetricFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AudienceDimensionOrMetricFilter> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
Returns
Type | Description |
boolean | The atAnyPointInTime.
|
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;
Returns
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;
Returns
getDefaultInstanceForType()
public AudienceDimensionOrMetricFilter getDefaultInstanceForType()
Returns
getFieldName()
public String getFieldName()
Required. Immutable. The dimension name or metric name to filter.
string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
Type | Description |
String | The fieldName.
|
getFieldNameBytes()
public ByteString getFieldNameBytes()
Required. Immutable. The dimension name or metric name to filter.
string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
Returns
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 (i.e., 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
Type | Description |
int | The inAnyNDayPeriod.
|
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;
Returns
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;
Returns
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;
Returns
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;
Returns
getOneFilterCase()
public AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()
Returns
getParserForType()
public Parser<AudienceDimensionOrMetricFilter> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
Returns
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;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
Returns
Type | Description |
boolean | Whether the betweenFilter field is set.
|
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;
Returns
Type | Description |
boolean | Whether the inListFilter field is set.
|
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;
Returns
Type | Description |
boolean | Whether the numericFilter field is set.
|
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;
Returns
Type | Description |
boolean | Whether the stringFilter field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AudienceDimensionOrMetricFilter.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AudienceDimensionOrMetricFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AudienceDimensionOrMetricFilter.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions