Class FunnelEventFilter (0.54.0)

public final class FunnelEventFilter extends GeneratedMessageV3 implements FunnelEventFilterOrBuilder

Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.

Protobuf type google.analytics.data.v1alpha.FunnelEventFilter

Static Fields

EVENT_NAME_FIELD_NUMBER

public static final int EVENT_NAME_FIELD_NUMBER
Field Value
Type Description
int

FUNNEL_PARAMETER_FILTER_EXPRESSION_FIELD_NUMBER

public static final int FUNNEL_PARAMETER_FILTER_EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunnelEventFilter getDefaultInstance()
Returns
Type Description
FunnelEventFilter

getDescriptor()

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

newBuilder()

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

newBuilder(FunnelEventFilter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public FunnelEventFilter getDefaultInstanceForType()
Returns
Type Description
FunnelEventFilter

getEventName()

public String getEventName()

This filter matches events of this single event name. Event name is required.

optional string event_name = 1;

Returns
Type Description
String

The eventName.

getEventNameBytes()

public ByteString getEventNameBytes()

This filter matches events of this single event name. Event name is required.

optional string event_name = 1;

Returns
Type Description
ByteString

The bytes for eventName.

getFunnelParameterFilterExpression()

public FunnelParameterFilterExpression getFunnelParameterFilterExpression()

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

optional .google.analytics.data.v1alpha.FunnelParameterFilterExpression funnel_parameter_filter_expression = 2;

Returns
Type Description
FunnelParameterFilterExpression

The funnelParameterFilterExpression.

getFunnelParameterFilterExpressionOrBuilder()

public FunnelParameterFilterExpressionOrBuilder getFunnelParameterFilterExpressionOrBuilder()

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

optional .google.analytics.data.v1alpha.FunnelParameterFilterExpression funnel_parameter_filter_expression = 2;

Returns
Type Description
FunnelParameterFilterExpressionOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEventName()

public boolean hasEventName()

This filter matches events of this single event name. Event name is required.

optional string event_name = 1;

Returns
Type Description
boolean

Whether the eventName field is set.

hasFunnelParameterFilterExpression()

public boolean hasFunnelParameterFilterExpression()

If specified, this filter matches events that match both the single event name and the parameter filter expressions.

Inside the parameter filter expression, only parameter filters are available.

optional .google.analytics.data.v1alpha.FunnelParameterFilterExpression funnel_parameter_filter_expression = 2;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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