com.google.analytics.data.v1alpha

Class Segment.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

com.google.analytics.data.v1alpha.Segment.Builder

All Implemented Interfaces:

SegmentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Segment

public static final class Segment.Builder
extends com.google.protobuf.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](https://support.google.com/analytics/answer/9304353).
 

Protobuf type google.analytics.data.v1alpha.Segment

Method Summary

Modifier and Type	Method and Description
Segment.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Segment	build()
Segment	buildPartial()
Segment.Builder	clear()
Segment.Builder	clearEventSegment() Event segments are subsets of events that were triggered on your site or app.
Segment.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Segment.Builder	clearName() The name for this segment.
Segment.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Segment.Builder	clearOneSegmentScope()
Segment.Builder	clearSessionSegment() Session segments are subsets of the sessions that occurred on your site or app.
Segment.Builder	clearUserSegment() User segments are subsets of users who engaged with your site or app.
Segment.Builder	clone()
Segment	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
EventSegment	getEventSegment() Event segments are subsets of events that were triggered on your site or app.
EventSegment.Builder	getEventSegmentBuilder() Event segments are subsets of events that were triggered on your site or app.
EventSegmentOrBuilder	getEventSegmentOrBuilder() Event segments are subsets of events that were triggered on your site or app.
String	getName() The name for this segment.
com.google.protobuf.ByteString	getNameBytes() The name for this segment.
Segment.OneSegmentScopeCase	getOneSegmentScopeCase()
SessionSegment	getSessionSegment() Session segments are subsets of the sessions that occurred on your site or app.
SessionSegment.Builder	getSessionSegmentBuilder() Session segments are subsets of the sessions that occurred on your site or app.
SessionSegmentOrBuilder	getSessionSegmentOrBuilder() Session segments are subsets of the sessions that occurred on your site or app.
UserSegment	getUserSegment() User segments are subsets of users who engaged with your site or app.
UserSegment.Builder	getUserSegmentBuilder() User segments are subsets of users who engaged with your site or app.
UserSegmentOrBuilder	getUserSegmentOrBuilder() User segments are subsets of users who engaged with your site or app.
boolean	hasEventSegment() Event segments are subsets of events that were triggered on your site or app.
boolean	hasSessionSegment() Session segments are subsets of the sessions that occurred on your site or app.
boolean	hasUserSegment() User segments are subsets of users who engaged with your site or app.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Segment.Builder	mergeEventSegment(EventSegment value) Event segments are subsets of events that were triggered on your site or app.
Segment.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Segment.Builder	mergeFrom(com.google.protobuf.Message other)
Segment.Builder	mergeFrom(Segment other)
Segment.Builder	mergeSessionSegment(SessionSegment value) Session segments are subsets of the sessions that occurred on your site or app.
Segment.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Segment.Builder	mergeUserSegment(UserSegment value) User segments are subsets of users who engaged with your site or app.
Segment.Builder	setEventSegment(EventSegment.Builder builderForValue) Event segments are subsets of events that were triggered on your site or app.
Segment.Builder	setEventSegment(EventSegment value) Event segments are subsets of events that were triggered on your site or app.
Segment.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Segment.Builder	setName(String value) The name for this segment.
Segment.Builder	setNameBytes(com.google.protobuf.ByteString value) The name for this segment.
Segment.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Segment.Builder	setSessionSegment(SessionSegment.Builder builderForValue) Session segments are subsets of the sessions that occurred on your site or app.
Segment.Builder	setSessionSegment(SessionSegment value) Session segments are subsets of the sessions that occurred on your site or app.
Segment.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Segment.Builder	setUserSegment(UserSegment.Builder builderForValue) User segments are subsets of users who engaged with your site or app.
Segment.Builder	setUserSegment(UserSegment value) User segments are subsets of users who engaged with your site or app.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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

clear

public Segment.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

getDefaultInstanceForType

public Segment getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Segment build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Segment buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Segment.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

clearField

public Segment.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

clearOneof

public Segment.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

addRepeatedField

public Segment.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

mergeFrom

public Segment.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Segment.Builder>

mergeFrom

public Segment.Builder mergeFrom(Segment other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

mergeFrom

public Segment.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Segment.Builder>

Throws:

IOException

getOneSegmentScopeCase

public Segment.OneSegmentScopeCase getOneSegmentScopeCase()

Specified by:

getOneSegmentScopeCase in interface SegmentOrBuilder

clearOneSegmentScope

public Segment.Builder clearOneSegmentScope()

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 (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Specified by:

getName in interface SegmentOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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 (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Specified by:

getNameBytes in interface SegmentOrBuilder

Returns:

The bytes for name.

setName

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 (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Parameters:

value - The name to set.

Returns:

This builder for chaining.

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 (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Returns:

This builder for chaining.

setNameBytes

public Segment.Builder setNameBytes(com.google.protobuf.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 (i.e. "1. Segment", "2. Segment", etc.).
 

string name = 1;

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

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;

Specified by:

hasUserSegment in interface SegmentOrBuilder

Returns:

Whether the userSegment field is set.

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;

Specified by:

getUserSegment in interface SegmentOrBuilder

Returns:

The userSegment.

setUserSegment

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;

setUserSegment

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;

mergeUserSegment

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;

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;

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;

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;

Specified by:

getUserSegmentOrBuilder in interface SegmentOrBuilder

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;

Specified by:

hasSessionSegment in interface SegmentOrBuilder

Returns:

Whether the sessionSegment field is set.

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;

Specified by:

getSessionSegment in interface SegmentOrBuilder

Returns:

The sessionSegment.

setSessionSegment

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;

setSessionSegment

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;

mergeSessionSegment

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;

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;

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;

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;

Specified by:

getSessionSegmentOrBuilder in interface SegmentOrBuilder

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;

Specified by:

hasEventSegment in interface SegmentOrBuilder

Returns:

Whether the eventSegment field is set.

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;

Specified by:

getEventSegment in interface SegmentOrBuilder

Returns:

The eventSegment.

setEventSegment

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;

setEventSegment

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;

mergeEventSegment

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;

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;

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;

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;

Specified by:

getEventSegmentOrBuilder in interface SegmentOrBuilder

setUnknownFields

public final Segment.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>

mergeUnknownFields

public final Segment.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Segment.Builder>