Class FunnelStep.Builder (0.57.0)

Version 0.57.0

• 0.63.0 (latest)
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0

public static final class FunnelStep.Builder extends GeneratedMessageV3.Builder<FunnelStep.Builder> implements FunnelStepOrBuilder

Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.

Protobuf type google.analytics.data.v1alpha.FunnelStep

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FunnelStep.Builder

Implements

FunnelStepOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FunnelStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public FunnelStep build()

Returns
Type	Description
FunnelStep

buildPartial()

public FunnelStep buildPartial()

Returns
Type	Description
FunnelStep

clear()

public FunnelStep.Builder clear()

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public FunnelStep.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterExpression()

public FunnelStep.Builder clearFilterExpression()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
Type	Description
FunnelStep.Builder

clearIsDirectlyFollowedBy()

public FunnelStep.Builder clearIsDirectlyFollowedBy()

If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, isDirectlyFollowedBy is treated as false.

bool is_directly_followed_by = 2;

Returns
Type	Description
FunnelStep.Builder	This builder for chaining.

clearName()

public FunnelStep.Builder clearName()

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Returns
Type	Description
FunnelStep.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FunnelStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearWithinDurationFromPriorStep()

public FunnelStep.Builder clearWithinDurationFromPriorStep()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
Type	Description
FunnelStep.Builder

clone()

public FunnelStep.Builder clone()

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public FunnelStep getDefaultInstanceForType()

Returns
Type	Description
FunnelStep

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilterExpression()

public FunnelFilterExpression getFilterExpression()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
Type	Description
FunnelFilterExpression	The filterExpression.

getFilterExpressionBuilder()

public FunnelFilterExpression.Builder getFilterExpressionBuilder()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
Type	Description
FunnelFilterExpression.Builder

getFilterExpressionOrBuilder()

public FunnelFilterExpressionOrBuilder getFilterExpressionOrBuilder()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
Type	Description
FunnelFilterExpressionOrBuilder

getIsDirectlyFollowedBy()

public boolean getIsDirectlyFollowedBy()

If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, isDirectlyFollowedBy is treated as false.

bool is_directly_followed_by = 2;

Returns
Type	Description
boolean	The isDirectlyFollowedBy.

getName()

public String getName()

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getWithinDurationFromPriorStep()

public Duration getWithinDurationFromPriorStep()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
Type	Description
Duration	The withinDurationFromPriorStep.

getWithinDurationFromPriorStepBuilder()

public Duration.Builder getWithinDurationFromPriorStepBuilder()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
Type	Description
Builder

getWithinDurationFromPriorStepOrBuilder()

public DurationOrBuilder getWithinDurationFromPriorStepOrBuilder()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
Type	Description
DurationOrBuilder

hasFilterExpression()

public boolean hasFilterExpression()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
Type	Description
boolean	Whether the filterExpression field is set.

hasWithinDurationFromPriorStep()

public boolean hasWithinDurationFromPriorStep()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
Type	Description
boolean	Whether the withinDurationFromPriorStep field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFilterExpression(FunnelFilterExpression value)

public FunnelStep.Builder mergeFilterExpression(FunnelFilterExpression value)

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Parameter
Name	Description
value	FunnelFilterExpression

Returns
Type	Description
FunnelStep.Builder

mergeFrom(FunnelStep other)

public FunnelStep.Builder mergeFrom(FunnelStep other)

Parameter
Name	Description
other	FunnelStep

Returns
Type	Description
FunnelStep.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunnelStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
FunnelStep.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public FunnelStep.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
FunnelStep.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FunnelStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeWithinDurationFromPriorStep(Duration value)

public FunnelStep.Builder mergeWithinDurationFromPriorStep(Duration value)

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Parameter
Name	Description
value	Duration

Returns
Type	Description
FunnelStep.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FunnelStep.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterExpression(FunnelFilterExpression value)

public FunnelStep.Builder setFilterExpression(FunnelFilterExpression value)

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Parameter
Name	Description
value	FunnelFilterExpression

Returns
Type	Description
FunnelStep.Builder

setFilterExpression(FunnelFilterExpression.Builder builderForValue)

public FunnelStep.Builder setFilterExpression(FunnelFilterExpression.Builder builderForValue)

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Parameter
Name	Description
builderForValue	FunnelFilterExpression.Builder

Returns
Type	Description
FunnelStep.Builder

setIsDirectlyFollowedBy(boolean value)

public FunnelStep.Builder setIsDirectlyFollowedBy(boolean value)

If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, isDirectlyFollowedBy is treated as false.

bool is_directly_followed_by = 2;

Parameter
Name	Description
value	boolean The isDirectlyFollowedBy to set.

Returns
Type	Description
FunnelStep.Builder	This builder for chaining.

setName(String value)

public FunnelStep.Builder setName(String value)

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
FunnelStep.Builder	This builder for chaining.

setNameBytes(ByteString value)

public FunnelStep.Builder setNameBytes(ByteString value)

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
FunnelStep.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final FunnelStep.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
FunnelStep.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setWithinDurationFromPriorStep(Duration value)

public FunnelStep.Builder setWithinDurationFromPriorStep(Duration value)

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Parameter
Name	Description
value	Duration

Returns
Type	Description
FunnelStep.Builder

setWithinDurationFromPriorStep(Duration.Builder builderForValue)

public FunnelStep.Builder setWithinDurationFromPriorStep(Duration.Builder builderForValue)

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond.

withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
FunnelStep.Builder