Class UserSegmentSequenceGroup.Builder (0.55.0)

public static final class UserSegmentSequenceGroup.Builder extends GeneratedMessageV3.Builder<UserSegmentSequenceGroup.Builder> 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 Methods

getDescriptor()

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

Methods

addAllUserSequenceSteps(Iterable<? extends UserSequenceStep> values)

public UserSegmentSequenceGroup.Builder addAllUserSequenceSteps(Iterable<? extends UserSequenceStep> values)

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
values Iterable<? extends com.google.analytics.data.v1alpha.UserSequenceStep>
Returns
Type Description
UserSegmentSequenceGroup.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addUserSequenceSteps(UserSequenceStep value)

public UserSegmentSequenceGroup.Builder addUserSequenceSteps(UserSequenceStep value)

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
value UserSequenceStep
Returns
Type Description
UserSegmentSequenceGroup.Builder

addUserSequenceSteps(UserSequenceStep.Builder builderForValue)

public UserSegmentSequenceGroup.Builder addUserSequenceSteps(UserSequenceStep.Builder builderForValue)

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
builderForValue UserSequenceStep.Builder
Returns
Type Description
UserSegmentSequenceGroup.Builder

addUserSequenceSteps(int index, UserSequenceStep value)

public UserSegmentSequenceGroup.Builder addUserSequenceSteps(int index, UserSequenceStep value)

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;

Parameters
Name Description
index int
value UserSequenceStep
Returns
Type Description
UserSegmentSequenceGroup.Builder

addUserSequenceSteps(int index, UserSequenceStep.Builder builderForValue)

public UserSegmentSequenceGroup.Builder addUserSequenceSteps(int index, UserSequenceStep.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue UserSequenceStep.Builder
Returns
Type Description
UserSegmentSequenceGroup.Builder

addUserSequenceStepsBuilder()

public UserSequenceStep.Builder addUserSequenceStepsBuilder()

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
UserSequenceStep.Builder

addUserSequenceStepsBuilder(int index)

public UserSequenceStep.Builder addUserSequenceStepsBuilder(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.Builder

build()

public UserSegmentSequenceGroup build()
Returns
Type Description
UserSegmentSequenceGroup

buildPartial()

public UserSegmentSequenceGroup buildPartial()
Returns
Type Description
UserSegmentSequenceGroup

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSequenceMaximumDuration()

public UserSegmentSequenceGroup.Builder clearSequenceMaximumDuration()

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
UserSegmentSequenceGroup.Builder

clearSequenceScoping()

public UserSegmentSequenceGroup.Builder clearSequenceScoping()

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
UserSegmentSequenceGroup.Builder

This builder for chaining.

clearUserSequenceSteps()

public UserSegmentSequenceGroup.Builder clearUserSequenceSteps()

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
UserSegmentSequenceGroup.Builder

clone()

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

getDefaultInstanceForType()

public UserSegmentSequenceGroup getDefaultInstanceForType()
Returns
Type Description
UserSegmentSequenceGroup

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

getSequenceMaximumDurationBuilder()

public Duration.Builder getSequenceMaximumDurationBuilder()

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
Builder

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.

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

getUserSequenceStepsBuilder(int index)

public UserSequenceStep.Builder getUserSequenceStepsBuilder(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.Builder

getUserSequenceStepsBuilderList()

public List<UserSequenceStep.Builder> getUserSequenceStepsBuilderList()

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<Builder>

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UserSegmentSequenceGroup other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeSequenceMaximumDuration(Duration value)

public UserSegmentSequenceGroup.Builder mergeSequenceMaximumDuration(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
UserSegmentSequenceGroup.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeUserSequenceSteps(int index)

public UserSegmentSequenceGroup.Builder removeUserSequenceSteps(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
UserSegmentSequenceGroup.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSequenceMaximumDuration(Duration value)

public UserSegmentSequenceGroup.Builder setSequenceMaximumDuration(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
UserSegmentSequenceGroup.Builder

setSequenceMaximumDuration(Duration.Builder builderForValue)

public UserSegmentSequenceGroup.Builder setSequenceMaximumDuration(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UserSegmentSequenceGroup.Builder

setSequenceScoping(UserCriteriaScoping value)

public UserSegmentSequenceGroup.Builder setSequenceScoping(UserCriteriaScoping value)

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;

Parameter
Name Description
value UserCriteriaScoping

The sequenceScoping to set.

Returns
Type Description
UserSegmentSequenceGroup.Builder

This builder for chaining.

setSequenceScopingValue(int value)

public UserSegmentSequenceGroup.Builder setSequenceScopingValue(int value)

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;

Parameter
Name Description
value int

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

Returns
Type Description
UserSegmentSequenceGroup.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUserSequenceSteps(int index, UserSequenceStep value)

public UserSegmentSequenceGroup.Builder setUserSequenceSteps(int index, UserSequenceStep value)

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;

Parameters
Name Description
index int
value UserSequenceStep
Returns
Type Description
UserSegmentSequenceGroup.Builder

setUserSequenceSteps(int index, UserSequenceStep.Builder builderForValue)

public UserSegmentSequenceGroup.Builder setUserSequenceSteps(int index, UserSequenceStep.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue UserSequenceStep.Builder
Returns
Type Description
UserSegmentSequenceGroup.Builder