Package com.google.analytics.data.v1alpha

Class Segment.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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 [Segment
 Builder](https://support.google.com/analytics/answer/9304353).
Protobuf type google.analytics.data.v1alpha.Segment

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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 (for example "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 (for example "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 (for example "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 (for example "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 (for example "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