Class UserSequenceStep (0.55.0) 

public final class UserSequenceStep extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UserSequenceStep

Static Fields

IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

public static final int IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_FILTER_EXPRESSION_FIELD_NUMBER

public static final int SEGMENT_FILTER_EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

STEP_SCOPING_FIELD_NUMBER

public static final int STEP_SCOPING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserSequenceStep getDefaultInstance()
Returns
Type Description
UserSequenceStep

getDescriptor()

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

newBuilder()

public static UserSequenceStep.Builder newBuilder()
Returns
Type Description
UserSequenceStep.Builder

newBuilder(UserSequenceStep prototype)

public static UserSequenceStep.Builder newBuilder(UserSequenceStep prototype)
Parameter
Name Description
prototype UserSequenceStep
Returns
Type Description
UserSequenceStep.Builder

parseDelimitedFrom(InputStream input)

public static UserSequenceStep parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UserSequenceStep parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserSequenceStep parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserSequenceStep parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UserSequenceStep parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UserSequenceStep parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserSequenceStep
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UserSequenceStep> parser()
Returns
Type Description
Parser<UserSequenceStep>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UserSequenceStep getDefaultInstanceForType()
Returns
Type Description
UserSequenceStep

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.

getParserForType()

public Parser<UserSequenceStep> getParserForType()
Returns
Type Description
Parser<UserSequenceStep>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UserSequenceStep.Builder newBuilderForType()
Returns
Type Description
UserSequenceStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserSequenceStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UserSequenceStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UserSequenceStep.Builder toBuilder()
Returns
Type Description
UserSequenceStep.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException