com.google.analytics.data.v1alpha

Class FunnelStep

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.FunnelStep

All Implemented Interfaces:

FunnelStepOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class FunnelStep
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunnelStep.Builder Steps define the user journey you want to measure.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_EXPRESSION_FIELD_NUMBER
static int	IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FunnelStep	getDefaultInstance()
FunnelStep	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FunnelFilterExpression	getFilterExpression() The condition that your users must meet to be included in this step of the funnel journey.
FunnelFilterExpressionOrBuilder	getFilterExpressionOrBuilder() The condition that your users must meet to be included in this step of the funnel journey.
boolean	getIsDirectlyFollowedBy() If true, this step must directly follow the previous step.
String	getName() The distinctive name for this step.
com.google.protobuf.ByteString	getNameBytes() The distinctive name for this step.
com.google.protobuf.Parser<FunnelStep>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.Duration	getWithinDurationFromPriorStep() If specified, this step must complete within this duration of the completion of the prior step.
com.google.protobuf.DurationOrBuilder	getWithinDurationFromPriorStepOrBuilder() If specified, this step must complete within this duration of the completion of the prior step.
boolean	hasFilterExpression() The condition that your users must meet to be included in this step of the funnel journey.
int	hashCode()
boolean	hasWithinDurationFromPriorStep() If specified, this step must complete within this duration of the completion of the prior step.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FunnelStep.Builder	newBuilder()
static FunnelStep.Builder	newBuilder(FunnelStep prototype)
FunnelStep.Builder	newBuilderForType()
protected FunnelStep.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FunnelStep	parseDelimitedFrom(InputStream input)
static FunnelStep	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunnelStep	parseFrom(byte[] data)
static FunnelStep	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunnelStep	parseFrom(ByteBuffer data)
static FunnelStep	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunnelStep	parseFrom(com.google.protobuf.ByteString data)
static FunnelStep	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunnelStep	parseFrom(com.google.protobuf.CodedInputStream input)
static FunnelStep	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunnelStep	parseFrom(InputStream input)
static FunnelStep	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FunnelStep>	parser()
FunnelStep.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

public static final int IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

See Also:

Constant Field Values

WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER

public static final int WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_EXPRESSION_FIELD_NUMBER

public static final int FILTER_EXPRESSION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (i.e. "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;

Specified by:

getName in interface FunnelStepOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (i.e. "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;

Specified by:

getNameBytes in interface FunnelStepOrBuilder

Returns:

The bytes for name.

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;

Specified by:

getIsDirectlyFollowedBy in interface FunnelStepOrBuilder

Returns:

The isDirectlyFollowedBy.

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;

Specified by:

hasWithinDurationFromPriorStep in interface FunnelStepOrBuilder

Returns:

Whether the withinDurationFromPriorStep field is set.

getWithinDurationFromPriorStep

public com.google.protobuf.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;

Specified by:

getWithinDurationFromPriorStep in interface FunnelStepOrBuilder

Returns:

The withinDurationFromPriorStep.

getWithinDurationFromPriorStepOrBuilder

public com.google.protobuf.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;

Specified by:

getWithinDurationFromPriorStepOrBuilder in interface FunnelStepOrBuilder

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;

Specified by:

hasFilterExpression in interface FunnelStepOrBuilder

Returns:

Whether the filterExpression field is set.

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;

Specified by:

getFilterExpression in interface FunnelStepOrBuilder

Returns:

The filterExpression.

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;

Specified by:

getFilterExpressionOrBuilder in interface FunnelStepOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FunnelStep parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunnelStep parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static FunnelStep parseFrom(InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static FunnelStep parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static FunnelStep parseDelimitedFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static FunnelStep parseFrom(com.google.protobuf.CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static FunnelStep parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public FunnelStep.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FunnelStep.Builder newBuilder()

newBuilder

public static FunnelStep.Builder newBuilder(FunnelStep prototype)

toBuilder

public FunnelStep.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FunnelStep.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FunnelStep getDefaultInstance()

parser

public static com.google.protobuf.Parser<FunnelStep> parser()

getParserForType

public com.google.protobuf.Parser<FunnelStep> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FunnelStep getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder