Interface UserSegmentSequenceGroupOrBuilder (0.52.0)

public interface UserSegmentSequenceGroupOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSequenceMaximumDuration()

public abstract Duration getSequenceMaximumDuration()

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

.google.protobuf.Duration sequence_maximum_duration = 2;

Returns
TypeDescription
Duration

The sequenceMaximumDuration.

getSequenceMaximumDurationOrBuilder()

public abstract DurationOrBuilder getSequenceMaximumDurationOrBuilder()

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

.google.protobuf.Duration sequence_maximum_duration = 2;

Returns
TypeDescription
DurationOrBuilder

getSequenceScoping()

public abstract UserCriteriaScoping getSequenceScoping()

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

Optional. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

.google.analytics.data.v1alpha.UserCriteriaScoping sequence_scoping = 1;

Returns
TypeDescription
UserCriteriaScoping

The sequenceScoping.

getSequenceScopingValue()

public abstract int getSequenceScopingValue()

All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION, all sequence steps must complete within one session for the user to match the sequence. sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT is not supported.

Optional. If unspecified, conditionScoping = ACROSS_ALL_SESSIONS is used.

.google.analytics.data.v1alpha.UserCriteriaScoping sequence_scoping = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for sequenceScoping.

getUserSequenceSteps(int index)

public abstract UserSequenceStep getUserSequenceSteps(int index)

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

repeated .google.analytics.data.v1alpha.UserSequenceStep user_sequence_steps = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
UserSequenceStep

getUserSequenceStepsCount()

public abstract int getUserSequenceStepsCount()

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

repeated .google.analytics.data.v1alpha.UserSequenceStep user_sequence_steps = 3;

Returns
TypeDescription
int

getUserSequenceStepsList()

public abstract List<UserSequenceStep> getUserSequenceStepsList()

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

repeated .google.analytics.data.v1alpha.UserSequenceStep user_sequence_steps = 3;

Returns
TypeDescription
List<UserSequenceStep>

getUserSequenceStepsOrBuilder(int index)

public abstract UserSequenceStepOrBuilder getUserSequenceStepsOrBuilder(int index)

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

repeated .google.analytics.data.v1alpha.UserSequenceStep user_sequence_steps = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
UserSequenceStepOrBuilder

getUserSequenceStepsOrBuilderList()

public abstract List<? extends UserSequenceStepOrBuilder> getUserSequenceStepsOrBuilderList()

An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the UserSegmentSequenceGroup.

repeated .google.analytics.data.v1alpha.UserSequenceStep user_sequence_steps = 3;

Returns
TypeDescription
List<? extends com.google.analytics.data.v1alpha.UserSequenceStepOrBuilder>

hasSequenceMaximumDuration()

public abstract boolean hasSequenceMaximumDuration()

Defines the time period in which the whole sequence must occur; for example, 30 Minutes. sequenceMaximumDuration is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

sequenceMaximumDuration is optional, and if unspecified, sequences can be completed in any time duration.

.google.protobuf.Duration sequence_maximum_duration = 2;

Returns
TypeDescription
boolean

Whether the sequenceMaximumDuration field is set.