Package com.google.analytics.data.v1alpha

Class FunnelStep.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FunnelStep.Builder>
com.google.analytics.data.v1alpha.FunnelStep.Builder
All Implemented Interfaces:
FunnelStepOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
FunnelStep
public static final class FunnelStep.Builder extends com.google.protobuf.GeneratedMessage.Builder<FunnelStep.Builder> implements FunnelStepOrBuilder
 Steps define the user journey you want to measure. Steps contain one or
 more conditions that your users must meet to be included in that step of
 the funnel journey.
Protobuf type google.analytics.data.v1alpha.FunnelStep

  • 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<FunnelStep.Builder>

    • clear

      public FunnelStep.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<FunnelStep.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<FunnelStep.Builder>

    • getDefaultInstanceForType

      public FunnelStep getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public FunnelStep build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public FunnelStep buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public FunnelStep.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<FunnelStep.Builder>

    • mergeFrom

      public FunnelStep.Builder mergeFrom(FunnelStep other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<FunnelStep.Builder>

    • mergeFrom

      public FunnelStep.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<FunnelStep.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Specified by:
      getName in interface FunnelStepOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Specified by:
      getNameBytes in interface FunnelStepOrBuilder
      Returns:
      The bytes for name.

    • setName

      public FunnelStep.Builder setName(String value)
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public FunnelStep.Builder clearName()
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Returns:
      This builder for chaining.

    • setNameBytes

      public FunnelStep.Builder setNameBytes(com.google.protobuf.ByteString value)
       The distinctive name for this step. If unspecified, steps will be named
 by a 1 based indexed name (for example "0. ", "1. ", etc.). This name
 defines string value returned by the `funnelStepName` dimension. For
 example, specifying `name = Purchase` in the request's third funnel step
 will produce `3. Purchase` in the funnel report response.
      string name = 1;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getIsDirectlyFollowedBy

      public boolean getIsDirectlyFollowedBy()
       If true, this step must directly follow the previous step. If false,
 there can be events between the previous step and this step. If
 unspecified, `isDirectlyFollowedBy` is treated as false.
      bool is_directly_followed_by = 2;
      Specified by:
      getIsDirectlyFollowedBy in interface FunnelStepOrBuilder
      Returns:
      The isDirectlyFollowedBy.

    • setIsDirectlyFollowedBy

      public FunnelStep.Builder setIsDirectlyFollowedBy(boolean value)
       If true, this step must directly follow the previous step. If false,
 there can be events between the previous step and this step. If
 unspecified, `isDirectlyFollowedBy` is treated as false.
      bool is_directly_followed_by = 2;
      Parameters:
      value - The isDirectlyFollowedBy to set.
      Returns:
      This builder for chaining.

    • clearIsDirectlyFollowedBy

      public FunnelStep.Builder clearIsDirectlyFollowedBy()
       If true, this step must directly follow the previous step. If false,
 there can be events between the previous step and this step. If
 unspecified, `isDirectlyFollowedBy` is treated as false.
      bool is_directly_followed_by = 2;
      Returns:
      This builder for chaining.

    • hasWithinDurationFromPriorStep

      public boolean hasWithinDurationFromPriorStep()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;
      Specified by:
      hasWithinDurationFromPriorStep in interface FunnelStepOrBuilder
      Returns:
      Whether the withinDurationFromPriorStep field is set.

    • getWithinDurationFromPriorStep

      public com.google.protobuf.Duration getWithinDurationFromPriorStep()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;
      Specified by:
      getWithinDurationFromPriorStep in interface FunnelStepOrBuilder
      Returns:
      The withinDurationFromPriorStep.

    • setWithinDurationFromPriorStep

      public FunnelStep.Builder setWithinDurationFromPriorStep(com.google.protobuf.Duration value)
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • setWithinDurationFromPriorStep

      public FunnelStep.Builder setWithinDurationFromPriorStep(com.google.protobuf.Duration.Builder builderForValue)
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • mergeWithinDurationFromPriorStep

      public FunnelStep.Builder mergeWithinDurationFromPriorStep(com.google.protobuf.Duration value)
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • clearWithinDurationFromPriorStep

      public FunnelStep.Builder clearWithinDurationFromPriorStep()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • getWithinDurationFromPriorStepBuilder

      public com.google.protobuf.Duration.Builder getWithinDurationFromPriorStepBuilder()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;

    • getWithinDurationFromPriorStepOrBuilder

      public com.google.protobuf.DurationOrBuilder getWithinDurationFromPriorStepOrBuilder()
       If specified, this step must complete within this duration of the
 completion of the prior step. `withinDurationFromPriorStep` is inclusive
 of the endpoint at the microsecond granularity. For example a duration of
 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1
 microsecond.

 `withinDurationFromPriorStep` is optional, and if unspecified, steps may
 be separated by any time duration.
      optional .google.protobuf.Duration within_duration_from_prior_step = 3;
      Specified by:
      getWithinDurationFromPriorStepOrBuilder in interface FunnelStepOrBuilder

    • hasFilterExpression

      public boolean hasFilterExpression()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;
      Specified by:
      hasFilterExpression in interface FunnelStepOrBuilder
      Returns:
      Whether the filterExpression field is set.

    • getFilterExpression

      public FunnelFilterExpression getFilterExpression()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;
      Specified by:
      getFilterExpression in interface FunnelStepOrBuilder
      Returns:
      The filterExpression.

    • setFilterExpression

      public FunnelStep.Builder setFilterExpression(FunnelFilterExpression value)
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

    • setFilterExpression

      public FunnelStep.Builder setFilterExpression(FunnelFilterExpression.Builder builderForValue)
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

    • mergeFilterExpression

      public FunnelStep.Builder mergeFilterExpression(FunnelFilterExpression value)
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

    • clearFilterExpression

      public FunnelStep.Builder clearFilterExpression()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

    • getFilterExpressionBuilder

      public FunnelFilterExpression.Builder getFilterExpressionBuilder()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

    • getFilterExpressionOrBuilder

      public FunnelFilterExpressionOrBuilder getFilterExpressionOrBuilder()
       The condition that your users must meet to be included in this step of
 the funnel journey.
      .google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;
      Specified by:
      getFilterExpressionOrBuilder in interface FunnelStepOrBuilder