Class UserSegmentSequenceGroup (0.53.0)

public final class UserSegmentSequenceGroup extends GeneratedMessageV3 implements UserSegmentSequenceGroupOrBuilder

Define conditions that must occur in a specific order for the user to be a member of the segment.

Protobuf type google.analytics.data.v1alpha.UserSegmentSequenceGroup

Static Fields

SEQUENCE_MAXIMUM_DURATION_FIELD_NUMBER

public static final int SEQUENCE_MAXIMUM_DURATION_FIELD_NUMBER
Field Value
Type Description
int

SEQUENCE_SCOPING_FIELD_NUMBER

public static final int SEQUENCE_SCOPING_FIELD_NUMBER
Field Value
Type Description
int

USER_SEQUENCE_STEPS_FIELD_NUMBER

public static final int USER_SEQUENCE_STEPS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserSegmentSequenceGroup getDefaultInstance()
Returns
Type Description
UserSegmentSequenceGroup

getDescriptor()

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

newBuilder()

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

newBuilder(UserSegmentSequenceGroup prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UserSegmentSequenceGroup getDefaultInstanceForType()
Returns
Type Description
UserSegmentSequenceGroup

getParserForType()

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

getSequenceMaximumDuration()

public 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
Type Description
Duration

The sequenceMaximumDuration.

getSequenceMaximumDurationOrBuilder()

public 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
Type Description
DurationOrBuilder

getSequenceScoping()

public 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
Type Description
UserCriteriaScoping

The sequenceScoping.

getSequenceScopingValue()

public 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
Type Description
int

The enum numeric value on the wire for sequenceScoping.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserSequenceSteps(int index)

public 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
Name Description
index int
Returns
Type Description
UserSequenceStep

getUserSequenceStepsCount()

public 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
Type Description
int

getUserSequenceStepsList()

public 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
Type Description
List<UserSequenceStep>

getUserSequenceStepsOrBuilder(int index)

public 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
Name Description
index int
Returns
Type Description
UserSequenceStepOrBuilder

getUserSequenceStepsOrBuilderList()

public 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
Type Description
List<? extends com.google.analytics.data.v1alpha.UserSequenceStepOrBuilder>

hasSequenceMaximumDuration()

public 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
Type Description
boolean

Whether the sequenceMaximumDuration 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 UserSegmentSequenceGroup.Builder newBuilderForType()
Returns
Type Description
UserSegmentSequenceGroup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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