com.google.analytics.data.v1alpha

Class SegmentParameterFilterScoping.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

com.google.analytics.data.v1alpha.SegmentParameterFilterScoping.Builder

All Implemented Interfaces:

SegmentParameterFilterScopingOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

SegmentParameterFilterScoping

public static final class SegmentParameterFilterScoping.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>
implements SegmentParameterFilterScopingOrBuilder

 Scopings specify how multiple events should be considered when evaluating a
 segment parameter filter.
 

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterScoping

Method Summary

Modifier and Type	Method and Description
SegmentParameterFilterScoping.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SegmentParameterFilterScoping	build()
SegmentParameterFilterScoping	buildPartial()
SegmentParameterFilterScoping.Builder	clear()
SegmentParameterFilterScoping.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SegmentParameterFilterScoping.Builder	clearInAnyNDayPeriod() Accumulates the parameter over the specified period of days before applying the filter.
SegmentParameterFilterScoping.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SegmentParameterFilterScoping.Builder	clone()
SegmentParameterFilterScoping	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
long	getInAnyNDayPeriod() Accumulates the parameter over the specified period of days before applying the filter.
boolean	hasInAnyNDayPeriod() Accumulates the parameter over the specified period of days before applying the filter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SegmentParameterFilterScoping.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SegmentParameterFilterScoping.Builder	mergeFrom(com.google.protobuf.Message other)
SegmentParameterFilterScoping.Builder	mergeFrom(SegmentParameterFilterScoping other)
SegmentParameterFilterScoping.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SegmentParameterFilterScoping.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SegmentParameterFilterScoping.Builder	setInAnyNDayPeriod(long value) Accumulates the parameter over the specified period of days before applying the filter.
SegmentParameterFilterScoping.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SegmentParameterFilterScoping.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

clear

public SegmentParameterFilterScoping.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.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.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.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

getDefaultInstanceForType

public SegmentParameterFilterScoping getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SegmentParameterFilterScoping build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SegmentParameterFilterScoping buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SegmentParameterFilterScoping.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

setField

public SegmentParameterFilterScoping.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

clearField

public SegmentParameterFilterScoping.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

clearOneof

public SegmentParameterFilterScoping.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

setRepeatedField

public SegmentParameterFilterScoping.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

addRepeatedField

public SegmentParameterFilterScoping.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

mergeFrom

public SegmentParameterFilterScoping.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<SegmentParameterFilterScoping.Builder>

mergeFrom

public SegmentParameterFilterScoping.Builder mergeFrom(SegmentParameterFilterScoping other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

mergeFrom

public SegmentParameterFilterScoping.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<SegmentParameterFilterScoping.Builder>

Throws:

IOException

hasInAnyNDayPeriod

public boolean hasInAnyNDayPeriod()

 Accumulates the parameter over the specified period of days before
 applying the filter. Only supported if criteria scoping is
 `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
 parameter is `event_count`.
 For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
 the event parameter is "event_count", and the Filter's criteria is
 greater than 5, this filter will accumulate the event count of purchase
 events over every 3 consecutive day period in the report's date range; a
 user will pass this Filter's criteria to be included in this segment if
 their count of purchase events exceeds 5 in any 3 consecutive day period.
 For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
 The date range is not extended for the purpose of having a full N day
 window near the start of the date range. For example if a report is for
 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
 period will be effectively shortened because no event data outside the
 report's date range will be read. For example, the first four periods
 will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
 `inAnyNDayPeriod` is optional. If not specified, the
 `segmentParameterFilter` is applied to each event individually.
 

optional int64 in_any_n_day_period = 1;

Specified by:

hasInAnyNDayPeriod in interface SegmentParameterFilterScopingOrBuilder

Returns:

Whether the inAnyNDayPeriod field is set.

getInAnyNDayPeriod

public long getInAnyNDayPeriod()

 Accumulates the parameter over the specified period of days before
 applying the filter. Only supported if criteria scoping is
 `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
 parameter is `event_count`.
 For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
 the event parameter is "event_count", and the Filter's criteria is
 greater than 5, this filter will accumulate the event count of purchase
 events over every 3 consecutive day period in the report's date range; a
 user will pass this Filter's criteria to be included in this segment if
 their count of purchase events exceeds 5 in any 3 consecutive day period.
 For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
 The date range is not extended for the purpose of having a full N day
 window near the start of the date range. For example if a report is for
 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
 period will be effectively shortened because no event data outside the
 report's date range will be read. For example, the first four periods
 will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
 `inAnyNDayPeriod` is optional. If not specified, the
 `segmentParameterFilter` is applied to each event individually.
 

optional int64 in_any_n_day_period = 1;

Specified by:

getInAnyNDayPeriod in interface SegmentParameterFilterScopingOrBuilder

Returns:

The inAnyNDayPeriod.

setInAnyNDayPeriod

public SegmentParameterFilterScoping.Builder setInAnyNDayPeriod(long value)

 Accumulates the parameter over the specified period of days before
 applying the filter. Only supported if criteria scoping is
 `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
 parameter is `event_count`.
 For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
 the event parameter is "event_count", and the Filter's criteria is
 greater than 5, this filter will accumulate the event count of purchase
 events over every 3 consecutive day period in the report's date range; a
 user will pass this Filter's criteria to be included in this segment if
 their count of purchase events exceeds 5 in any 3 consecutive day period.
 For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
 The date range is not extended for the purpose of having a full N day
 window near the start of the date range. For example if a report is for
 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
 period will be effectively shortened because no event data outside the
 report's date range will be read. For example, the first four periods
 will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
 `inAnyNDayPeriod` is optional. If not specified, the
 `segmentParameterFilter` is applied to each event individually.
 

optional int64 in_any_n_day_period = 1;

Parameters:

value - The inAnyNDayPeriod to set.

Returns:

This builder for chaining.

clearInAnyNDayPeriod

public SegmentParameterFilterScoping.Builder clearInAnyNDayPeriod()

 Accumulates the parameter over the specified period of days before
 applying the filter. Only supported if criteria scoping is
 `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the
 parameter is `event_count`.
 For example if `inAnyNDayPeriod` is 3, the event_name is "purchase",
 the event parameter is "event_count", and the Filter's criteria is
 greater than 5, this filter will accumulate the event count of purchase
 events over every 3 consecutive day period in the report's date range; a
 user will pass this Filter's criteria to be included in this segment if
 their count of purchase events exceeds 5 in any 3 consecutive day period.
 For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to
 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.
 The date range is not extended for the purpose of having a full N day
 window near the start of the date range. For example if a report is for
 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day
 period will be effectively shortened because no event data outside the
 report's date range will be read. For example, the first four periods
 will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02,
 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.
 `inAnyNDayPeriod` is optional. If not specified, the
 `segmentParameterFilter` is applied to each event individually.
 

optional int64 in_any_n_day_period = 1;

Returns:

This builder for chaining.

setUnknownFields

public final SegmentParameterFilterScoping.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>

mergeUnknownFields

public final SegmentParameterFilterScoping.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder>