Class UserSequenceStep.Builder (0.55.0)

public static final class UserSequenceStep.Builder extends GeneratedMessageV3.Builder<UserSequenceStep.Builder> implements UserSequenceStepOrBuilder

A condition that must occur in the specified step order for this user to match the sequence.

Protobuf type google.analytics.data.v1alpha.UserSequenceStep

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UserSequenceStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserSequenceStep.Builder
Overrides

build()

public UserSequenceStep build()
Returns
Type Description
UserSequenceStep

buildPartial()

public UserSequenceStep buildPartial()
Returns
Type Description
UserSequenceStep

clear()

public UserSequenceStep.Builder clear()
Returns
Type Description
UserSequenceStep.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UserSequenceStep.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UserSequenceStep.Builder
Overrides

clearIsDirectlyFollowedBy()

public UserSequenceStep.Builder clearIsDirectlyFollowedBy()

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

bool is_directly_followed_by = 1;

Returns
Type Description
UserSequenceStep.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UserSequenceStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UserSequenceStep.Builder
Overrides

clearSegmentFilterExpression()

public UserSequenceStep.Builder clearSegmentFilterExpression()

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Returns
Type Description
UserSequenceStep.Builder

clearStepScoping()

public UserSequenceStep.Builder clearStepScoping()

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

.google.analytics.data.v1alpha.UserCriteriaScoping step_scoping = 2;

Returns
Type Description
UserSequenceStep.Builder

This builder for chaining.

clone()

public UserSequenceStep.Builder clone()
Returns
Type Description
UserSequenceStep.Builder
Overrides

getDefaultInstanceForType()

public UserSequenceStep getDefaultInstanceForType()
Returns
Type Description
UserSequenceStep

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIsDirectlyFollowedBy()

public boolean getIsDirectlyFollowedBy()

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

bool is_directly_followed_by = 1;

Returns
Type Description
boolean

The isDirectlyFollowedBy.

getSegmentFilterExpression()

public SegmentFilterExpression getSegmentFilterExpression()

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Returns
Type Description
SegmentFilterExpression

The segmentFilterExpression.

getSegmentFilterExpressionBuilder()

public SegmentFilterExpression.Builder getSegmentFilterExpressionBuilder()

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Returns
Type Description
SegmentFilterExpression.Builder

getSegmentFilterExpressionOrBuilder()

public SegmentFilterExpressionOrBuilder getSegmentFilterExpressionOrBuilder()

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Returns
Type Description
SegmentFilterExpressionOrBuilder

getStepScoping()

public UserCriteriaScoping getStepScoping()

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

.google.analytics.data.v1alpha.UserCriteriaScoping step_scoping = 2;

Returns
Type Description
UserCriteriaScoping

The stepScoping.

getStepScopingValue()

public int getStepScopingValue()

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

.google.analytics.data.v1alpha.UserCriteriaScoping step_scoping = 2;

Returns
Type Description
int

The enum numeric value on the wire for stepScoping.

hasSegmentFilterExpression()

public boolean hasSegmentFilterExpression()

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Returns
Type Description
boolean

Whether the segmentFilterExpression field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UserSequenceStep other)

public UserSequenceStep.Builder mergeFrom(UserSequenceStep other)
Parameter
Name Description
other UserSequenceStep
Returns
Type Description
UserSequenceStep.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UserSequenceStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UserSequenceStep.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UserSequenceStep.Builder
Overrides

mergeSegmentFilterExpression(SegmentFilterExpression value)

public UserSequenceStep.Builder mergeSegmentFilterExpression(SegmentFilterExpression value)

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Parameter
Name Description
value SegmentFilterExpression
Returns
Type Description
UserSequenceStep.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UserSequenceStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserSequenceStep.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public UserSequenceStep.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserSequenceStep.Builder
Overrides

setIsDirectlyFollowedBy(boolean value)

public UserSequenceStep.Builder setIsDirectlyFollowedBy(boolean value)

If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. isDirectlyFollowedBy must be false for the first step.

bool is_directly_followed_by = 1;

Parameter
Name Description
value boolean

The isDirectlyFollowedBy to set.

Returns
Type Description
UserSequenceStep.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UserSequenceStep.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UserSequenceStep.Builder
Overrides

setSegmentFilterExpression(SegmentFilterExpression value)

public UserSequenceStep.Builder setSegmentFilterExpression(SegmentFilterExpression value)

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Parameter
Name Description
value SegmentFilterExpression
Returns
Type Description
UserSequenceStep.Builder

setSegmentFilterExpression(SegmentFilterExpression.Builder builderForValue)

public UserSequenceStep.Builder setSegmentFilterExpression(SegmentFilterExpression.Builder builderForValue)

A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters.

.google.analytics.data.v1alpha.SegmentFilterExpression segment_filter_expression = 3;

Parameter
Name Description
builderForValue SegmentFilterExpression.Builder
Returns
Type Description
UserSequenceStep.Builder

setStepScoping(UserCriteriaScoping value)

public UserSequenceStep.Builder setStepScoping(UserCriteriaScoping value)

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

.google.analytics.data.v1alpha.UserCriteriaScoping step_scoping = 2;

Parameter
Name Description
value UserCriteriaScoping

The stepScoping to set.

Returns
Type Description
UserSequenceStep.Builder

This builder for chaining.

setStepScopingValue(int value)

public UserSequenceStep.Builder setStepScopingValue(int value)

This sequence step must be satisfied in the scoping for the user to match the sequence. For example if sequenceScoping = WITHIN_SAME_SESSION, this sequence steps must complete within one session for the user to match the sequence. stepScoping = ACROSS_ALL_SESSIONS is only allowed if the sequenceScoping = ACROSS_ALL_SESSIONS.

Optional. If unspecified, stepScoping uses the same UserCriteriaScoping as the sequenceScoping.

.google.analytics.data.v1alpha.UserCriteriaScoping step_scoping = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for stepScoping to set.

Returns
Type Description
UserSequenceStep.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UserSequenceStep.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserSequenceStep.Builder
Overrides