Class Segment.Builder (0.45.0)

Version 0.45.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 Segment.Builder extends GeneratedMessageV3.Builder<Segment.Builder> implements SegmentOrBuilder

A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app.

To learn more, see GA4 Segment Builder.

Protobuf type google.analytics.data.v1alpha.Segment

Inheritance

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

Implements

SegmentOrBuilder

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 Segment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Segment.Builder

Overrides

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

build()

public Segment build()

Returns
Type	Description
Segment

buildPartial()

public Segment buildPartial()

Returns
Type	Description
Segment

clear()

public Segment.Builder clear()

Returns
Type	Description
Segment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEventSegment()

public Segment.Builder clearEventSegment()

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Returns
Type	Description
Segment.Builder

clearField(Descriptors.FieldDescriptor field)

public Segment.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Segment.Builder

Overrides

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

clearName()

public Segment.Builder clearName()

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

string name = 1;

Returns
Type	Description
Segment.Builder	This builder for chaining.

clearOneSegmentScope()

public Segment.Builder clearOneSegmentScope()

Returns
Type	Description
Segment.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Segment.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Segment.Builder

Overrides

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

clearSessionSegment()

public Segment.Builder clearSessionSegment()

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Returns
Type	Description
Segment.Builder

clearUserSegment()

public Segment.Builder clearUserSegment()

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Returns
Type	Description
Segment.Builder

clone()

public Segment.Builder clone()

Returns
Type	Description
Segment.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Segment getDefaultInstanceForType()

Returns
Type	Description
Segment

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEventSegment()

public EventSegment getEventSegment()

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Returns
Type	Description
EventSegment	The eventSegment.

getEventSegmentBuilder()

public EventSegment.Builder getEventSegmentBuilder()

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Returns
Type	Description
EventSegment.Builder

getEventSegmentOrBuilder()

public EventSegmentOrBuilder getEventSegmentOrBuilder()

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Returns
Type	Description
EventSegmentOrBuilder

getName()

public String getName()

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOneSegmentScopeCase()

public Segment.OneSegmentScopeCase getOneSegmentScopeCase()

Returns
Type	Description
Segment.OneSegmentScopeCase

getSessionSegment()

public SessionSegment getSessionSegment()

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Returns
Type	Description
SessionSegment	The sessionSegment.

getSessionSegmentBuilder()

public SessionSegment.Builder getSessionSegmentBuilder()

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Returns
Type	Description
SessionSegment.Builder

getSessionSegmentOrBuilder()

public SessionSegmentOrBuilder getSessionSegmentOrBuilder()

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Returns
Type	Description
SessionSegmentOrBuilder

getUserSegment()

public UserSegment getUserSegment()

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Returns
Type	Description
UserSegment	The userSegment.

getUserSegmentBuilder()

public UserSegment.Builder getUserSegmentBuilder()

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Returns
Type	Description
UserSegment.Builder

getUserSegmentOrBuilder()

public UserSegmentOrBuilder getUserSegmentOrBuilder()

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Returns
Type	Description
UserSegmentOrBuilder

hasEventSegment()

public boolean hasEventSegment()

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Returns
Type	Description
boolean	Whether the eventSegment field is set.

hasSessionSegment()

public boolean hasSessionSegment()

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Returns
Type	Description
boolean	Whether the sessionSegment field is set.

hasUserSegment()

public boolean hasUserSegment()

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Returns
Type	Description
boolean	Whether the userSegment 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()

mergeEventSegment(EventSegment value)

public Segment.Builder mergeEventSegment(EventSegment value)

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Parameter
Name	Description
value	EventSegment

Returns
Type	Description
Segment.Builder

mergeFrom(Segment other)

public Segment.Builder mergeFrom(Segment other)

Parameter
Name	Description
other	Segment

Returns
Type	Description
Segment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Segment.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Segment.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Segment.Builder

Overrides

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

mergeSessionSegment(SessionSegment value)

public Segment.Builder mergeSessionSegment(SessionSegment value)

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Parameter
Name	Description
value	SessionSegment

Returns
Type	Description
Segment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Segment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Segment.Builder

Overrides

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

mergeUserSegment(UserSegment value)

public Segment.Builder mergeUserSegment(UserSegment value)

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Parameter
Name	Description
value	UserSegment

Returns
Type	Description
Segment.Builder

setEventSegment(EventSegment value)

public Segment.Builder setEventSegment(EventSegment value)

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Parameter
Name	Description
value	EventSegment

Returns
Type	Description
Segment.Builder

setEventSegment(EventSegment.Builder builderForValue)

public Segment.Builder setEventSegment(EventSegment.Builder builderForValue)

Event segments are subsets of events that were triggered on your site or app.

.google.analytics.data.v1alpha.EventSegment event_segment = 4;

Parameter
Name	Description
builderForValue	EventSegment.Builder

Returns
Type	Description
Segment.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Segment.Builder

Overrides

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

setName(String value)

public Segment.Builder setName(String value)

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

string name = 1;

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Segment.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Segment.Builder setNameBytes(ByteString value)

The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the segment dimension. The segment dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.).

string name = 1;

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

Returns
Type	Description
Segment.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Segment.Builder

Overrides

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

setSessionSegment(SessionSegment value)

public Segment.Builder setSessionSegment(SessionSegment value)

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Parameter
Name	Description
value	SessionSegment

Returns
Type	Description
Segment.Builder

setSessionSegment(SessionSegment.Builder builderForValue)

public Segment.Builder setSessionSegment(SessionSegment.Builder builderForValue)

Session segments are subsets of the sessions that occurred on your site or app.

.google.analytics.data.v1alpha.SessionSegment session_segment = 3;

Parameter
Name	Description
builderForValue	SessionSegment.Builder

Returns
Type	Description
Segment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Segment.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Segment.Builder

Overrides

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

setUserSegment(UserSegment value)

public Segment.Builder setUserSegment(UserSegment value)

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Parameter
Name	Description
value	UserSegment

Returns
Type	Description
Segment.Builder

setUserSegment(UserSegment.Builder builderForValue)

public Segment.Builder setUserSegment(UserSegment.Builder builderForValue)

User segments are subsets of users who engaged with your site or app.

.google.analytics.data.v1alpha.UserSegment user_segment = 2;

Parameter
Name	Description
builderForValue	UserSegment.Builder

Returns
Type	Description
Segment.Builder