Class SegmentFilterScoping.Builder (0.53.0)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SegmentFilterScoping build()
Returns
Type Description
SegmentFilterScoping

buildPartial()

public SegmentFilterScoping buildPartial()
Returns
Type Description
SegmentFilterScoping

clear()

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

clearAtAnyPointInTime()

public SegmentFilterScoping.Builder clearAtAnyPointInTime()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public SegmentFilterScoping.Builder clone()
Returns
Type Description
SegmentFilterScoping.Builder
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

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SegmentFilterScoping other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAtAnyPointInTime(boolean value)

public SegmentFilterScoping.Builder setAtAnyPointInTime(boolean value)

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;

Parameter
Name Description
value boolean

The atAnyPointInTime to set.

Returns
Type Description
SegmentFilterScoping.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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