Funnel.Builder (proto-google-analytics-data-v1alpha 0.23.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Funnel.Builder>
    - - com.google.analytics.data.v1alpha.Funnel.Builder

All Implemented Interfaces:: FunnelOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Funnel

public static final class Funnel.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Funnel.Builder>
implements FunnelOrBuilder

 Configures the funnel in a funnel report request. A funnel reports on users
 as they pass through a sequence of steps.
 Funnel exploration lets you visualize the steps your users take to complete a
 task and quickly see how well they are succeeding or failing at each step.
 For example, how do prospects become shoppers and then become buyers? How do
 one time buyers become repeat buyers? With this information, you can improve
 inefficient or abandoned customer journeys.

Protobuf type google.analytics.data.v1alpha.Funnel

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Funnel.Builder`	`addAllSteps(Iterable<? extends FunnelStep> values)` The sequential steps of this funnel.
`Funnel.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Funnel.Builder`	`addSteps(FunnelStep.Builder builderForValue)` The sequential steps of this funnel.
`Funnel.Builder`	`addSteps(FunnelStep value)` The sequential steps of this funnel.
`Funnel.Builder`	`addSteps(int index, FunnelStep.Builder builderForValue)` The sequential steps of this funnel.
`Funnel.Builder`	`addSteps(int index, FunnelStep value)` The sequential steps of this funnel.
`FunnelStep.Builder`	`addStepsBuilder()` The sequential steps of this funnel.
`FunnelStep.Builder`	`addStepsBuilder(int index)` The sequential steps of this funnel.
`Funnel`	`build()`
`Funnel`	`buildPartial()`
`Funnel.Builder`	`clear()`
`Funnel.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Funnel.Builder`	`clearIsOpenFunnel()` In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step.
`Funnel.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Funnel.Builder`	`clearSteps()` The sequential steps of this funnel.
`Funnel.Builder`	`clone()`
`Funnel`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getIsOpenFunnel()` In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step.
`FunnelStep`	`getSteps(int index)` The sequential steps of this funnel.
`FunnelStep.Builder`	`getStepsBuilder(int index)` The sequential steps of this funnel.
`List<FunnelStep.Builder>`	`getStepsBuilderList()` The sequential steps of this funnel.
`int`	`getStepsCount()` The sequential steps of this funnel.
`List<FunnelStep>`	`getStepsList()` The sequential steps of this funnel.
`FunnelStepOrBuilder`	`getStepsOrBuilder(int index)` The sequential steps of this funnel.
`List<? extends FunnelStepOrBuilder>`	`getStepsOrBuilderList()` The sequential steps of this funnel.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Funnel.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Funnel.Builder`	`mergeFrom(Funnel other)`
`Funnel.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Funnel.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Funnel.Builder`	`removeSteps(int index)` The sequential steps of this funnel.
`Funnel.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Funnel.Builder`	`setIsOpenFunnel(boolean value)` In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step.
`Funnel.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Funnel.Builder`	`setSteps(int index, FunnelStep.Builder builderForValue)` The sequential steps of this funnel.
`Funnel.Builder`	`setSteps(int index, FunnelStep value)` The sequential steps of this funnel.
`Funnel.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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<Funnel.Builder>
  - clear
```
public Funnel.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<Funnel.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<Funnel.Builder>
  - getDefaultInstanceForType
```
public Funnel getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Funnel build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Funnel buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Funnel.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<Funnel.Builder>
  - setField
```
public Funnel.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<Funnel.Builder>
  - clearField
```
public Funnel.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<Funnel.Builder>
  - clearOneof
```
public Funnel.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<Funnel.Builder>
  - setRepeatedField
```
public Funnel.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<Funnel.Builder>
  - addRepeatedField
```
public Funnel.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<Funnel.Builder>
  - mergeFrom
```
public Funnel.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<Funnel.Builder>
  - mergeFrom
```
public Funnel.Builder mergeFrom(Funnel other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Funnel.Builder>
  - mergeFrom
```
public Funnel.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<Funnel.Builder>
    
    Throws:
    
    IOException
  - getIsOpenFunnel
```
public boolean getIsOpenFunnel()
```
```
 In an open funnel, users can enter the funnel in any step, and in a closed
 funnel, users must enter the funnel in the first step. Optional. If
 unspecified, a closed funnel is used.
 
```
    bool is_open_funnel = 1;
    Specified by:
    
    getIsOpenFunnel in interface FunnelOrBuilder
    
    Returns:
    
    The isOpenFunnel.
  - setIsOpenFunnel
```
public Funnel.Builder setIsOpenFunnel(boolean value)
```
```
 In an open funnel, users can enter the funnel in any step, and in a closed
 funnel, users must enter the funnel in the first step. Optional. If
 unspecified, a closed funnel is used.
 
```
    bool is_open_funnel = 1;
    Parameters:
    
    value - The isOpenFunnel to set.
    
    Returns:
    
    This builder for chaining.
  - clearIsOpenFunnel
```
public Funnel.Builder clearIsOpenFunnel()
```
```
 In an open funnel, users can enter the funnel in any step, and in a closed
 funnel, users must enter the funnel in the first step. Optional. If
 unspecified, a closed funnel is used.
 
```
    bool is_open_funnel = 1;
    Returns:
    
    This builder for chaining.
  - getStepsList
```
public List<FunnelStep> getStepsList()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
    Specified by:
    
    getStepsList in interface FunnelOrBuilder
  - getStepsCount
```
public int getStepsCount()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
    Specified by:
    
    getStepsCount in interface FunnelOrBuilder
  - getSteps
```
public FunnelStep getSteps(int index)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
    Specified by:
    
    getSteps in interface FunnelOrBuilder
  - setSteps
```
public Funnel.Builder setSteps(int index,
                               FunnelStep value)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - setSteps
```
public Funnel.Builder setSteps(int index,
                               FunnelStep.Builder builderForValue)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addSteps
```
public Funnel.Builder addSteps(FunnelStep value)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addSteps
```
public Funnel.Builder addSteps(int index,
                               FunnelStep value)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addSteps
```
public Funnel.Builder addSteps(FunnelStep.Builder builderForValue)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addSteps
```
public Funnel.Builder addSteps(int index,
                               FunnelStep.Builder builderForValue)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addAllSteps
```
public Funnel.Builder addAllSteps(Iterable<? extends FunnelStep> values)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - clearSteps
```
public Funnel.Builder clearSteps()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - removeSteps
```
public Funnel.Builder removeSteps(int index)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - getStepsBuilder
```
public FunnelStep.Builder getStepsBuilder(int index)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - getStepsOrBuilder
```
public FunnelStepOrBuilder getStepsOrBuilder(int index)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
    Specified by:
    
    getStepsOrBuilder in interface FunnelOrBuilder
  - getStepsOrBuilderList
```
public List<? extends FunnelStepOrBuilder> getStepsOrBuilderList()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
    Specified by:
    
    getStepsOrBuilderList in interface FunnelOrBuilder
  - addStepsBuilder
```
public FunnelStep.Builder addStepsBuilder()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - addStepsBuilder
```
public FunnelStep.Builder addStepsBuilder(int index)
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - getStepsBuilderList
```
public List<FunnelStep.Builder> getStepsBuilderList()
```
```
 The sequential steps of this funnel.
 
```
    repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;
  - setUnknownFields
```
public final Funnel.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<Funnel.Builder>
  - mergeUnknownFields
```
public final Funnel.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<Funnel.Builder>

Class Funnel.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getIsOpenFunnel

setIsOpenFunnel

clearIsOpenFunnel

getStepsList

getStepsCount

getSteps

setSteps

setSteps

addSteps

addSteps

addSteps

addSteps

addAllSteps

clearSteps

removeSteps

getStepsBuilder

getStepsOrBuilder

getStepsOrBuilderList

addStepsBuilder

addStepsBuilder

getStepsBuilderList

setUnknownFields

mergeUnknownFields