Class UserSequenceStep (0.31.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

Static Fields

IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

public static final int IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER
Field Value
TypeDescription
int

SEGMENT_FILTER_EXPRESSION_FIELD_NUMBER

public static final int SEGMENT_FILTER_EXPRESSION_FIELD_NUMBER
Field Value
TypeDescription
int

STEP_SCOPING_FIELD_NUMBER

public static final int STEP_SCOPING_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static UserSequenceStep getDefaultInstance()
Returns
TypeDescription
UserSequenceStep

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static UserSequenceStep.Builder newBuilder()
Returns
TypeDescription
UserSequenceStep.Builder

newBuilder(UserSequenceStep prototype)

public static UserSequenceStep.Builder newBuilder(UserSequenceStep prototype)
Parameter
NameDescription
prototypeUserSequenceStep
Returns
TypeDescription
UserSequenceStep.Builder

parseDelimitedFrom(InputStream input)

public static UserSequenceStep parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static UserSequenceStep parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserSequenceStep parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserSequenceStep parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static UserSequenceStep parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static UserSequenceStep parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserSequenceStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UserSequenceStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<UserSequenceStep> parser()
Returns
TypeDescription
Parser<UserSequenceStep>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public UserSequenceStep getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The isDirectlyFollowedBy.

getParserForType()

public Parser<UserSequenceStep> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
SegmentFilterExpressionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the segmentFilterExpression field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public UserSequenceStep.Builder newBuilderForType()
Returns
TypeDescription
UserSequenceStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserSequenceStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
UserSequenceStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public UserSequenceStep.Builder toBuilder()
Returns
TypeDescription
UserSequenceStep.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException