Class SegmentFilterScoping (0.63.0) 

public final class SegmentFilterScoping extends GeneratedMessageV3 implements SegmentFilterScopingOrBuilder

Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter.

Protobuf type google.analytics.data.v1alpha.SegmentFilterScoping

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SegmentFilterScoping

Static Fields

AT_ANY_POINT_IN_TIME_FIELD_NUMBER

public static final int AT_ANY_POINT_IN_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SegmentFilterScoping getDefaultInstance()
Returns
Type Description
SegmentFilterScoping

getDescriptor()

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

newBuilder()

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

newBuilder(SegmentFilterScoping prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAtAnyPointInTime()

public boolean getAtAnyPointInTime()

If atAnyPointInTime is true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request.

This atAnyPointInTime parameter does not extend the date range of events in the report. If atAnyPointInTime is true, only events within the report's date range are considered when evaluating this filter.

This atAnyPointInTime is only able to be specified if the criteria scoping is ACROSS_ALL_SESSIONS and is not able to be specified in sequences.

If the criteria scoping is ACROSS_ALL_SESSIONS, atAnyPointInTime = false is used if unspecified.

optional bool at_any_point_in_time = 1;

Returns
Type Description
boolean

The atAnyPointInTime.

getDefaultInstanceForType()

public SegmentFilterScoping getDefaultInstanceForType()
Returns
Type Description
SegmentFilterScoping

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAtAnyPointInTime()

public boolean hasAtAnyPointInTime()

If atAnyPointInTime is true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request.

This atAnyPointInTime parameter does not extend the date range of events in the report. If atAnyPointInTime is true, only events within the report's date range are considered when evaluating this filter.

This atAnyPointInTime is only able to be specified if the criteria scoping is ACROSS_ALL_SESSIONS and is not able to be specified in sequences.

If the criteria scoping is ACROSS_ALL_SESSIONS, atAnyPointInTime = false is used if unspecified.

optional bool at_any_point_in_time = 1;

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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