Class FunnelBreakdown.Builder (0.57.0)

public static final class FunnelBreakdown.Builder extends GeneratedMessageV3.Builder<FunnelBreakdown.Builder> implements FunnelBreakdownOrBuilder

Breakdowns add a dimension to the funnel table sub report response.

Protobuf type google.analytics.data.v1alpha.FunnelBreakdown

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FunnelBreakdown.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunnelBreakdown.Builder
Overrides

build()

public FunnelBreakdown build()
Returns
Type Description
FunnelBreakdown

buildPartial()

public FunnelBreakdown buildPartial()
Returns
Type Description
FunnelBreakdown

clear()

public FunnelBreakdown.Builder clear()
Returns
Type Description
FunnelBreakdown.Builder
Overrides

clearBreakdownDimension()

public FunnelBreakdown.Builder clearBreakdownDimension()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
FunnelBreakdown.Builder

clearField(Descriptors.FieldDescriptor field)

public FunnelBreakdown.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FunnelBreakdown.Builder
Overrides

clearLimit()

public FunnelBreakdown.Builder clearLimit()

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Returns
Type Description
FunnelBreakdown.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FunnelBreakdown.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FunnelBreakdown.Builder
Overrides

clone()

public FunnelBreakdown.Builder clone()
Returns
Type Description
FunnelBreakdown.Builder
Overrides

getBreakdownDimension()

public Dimension getBreakdownDimension()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
Dimension

The breakdownDimension.

getBreakdownDimensionBuilder()

public Dimension.Builder getBreakdownDimensionBuilder()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
Dimension.Builder

getBreakdownDimensionOrBuilder()

public DimensionOrBuilder getBreakdownDimensionOrBuilder()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
DimensionOrBuilder

getDefaultInstanceForType()

public FunnelBreakdown getDefaultInstanceForType()
Returns
Type Description
FunnelBreakdown

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLimit()

public long getLimit()

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Returns
Type Description
long

The limit.

hasBreakdownDimension()

public boolean hasBreakdownDimension()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
boolean

Whether the breakdownDimension field is set.

hasLimit()

public boolean hasLimit()

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Returns
Type Description
boolean

Whether the limit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBreakdownDimension(Dimension value)

public FunnelBreakdown.Builder mergeBreakdownDimension(Dimension value)

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Parameter
Name Description
value Dimension
Returns
Type Description
FunnelBreakdown.Builder

mergeFrom(FunnelBreakdown other)

public FunnelBreakdown.Builder mergeFrom(FunnelBreakdown other)
Parameter
Name Description
other FunnelBreakdown
Returns
Type Description
FunnelBreakdown.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunnelBreakdown.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelBreakdown.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FunnelBreakdown.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FunnelBreakdown.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FunnelBreakdown.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunnelBreakdown.Builder
Overrides

setBreakdownDimension(Dimension value)

public FunnelBreakdown.Builder setBreakdownDimension(Dimension value)

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Parameter
Name Description
value Dimension
Returns
Type Description
FunnelBreakdown.Builder

setBreakdownDimension(Dimension.Builder builderForValue)

public FunnelBreakdown.Builder setBreakdownDimension(Dimension.Builder builderForValue)

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Parameter
Name Description
builderForValue Dimension.Builder
Returns
Type Description
FunnelBreakdown.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FunnelBreakdown.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunnelBreakdown.Builder
Overrides

setLimit(long value)

public FunnelBreakdown.Builder setLimit(long value)

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Parameter
Name Description
value long

The limit to set.

Returns
Type Description
FunnelBreakdown.Builder

This builder for chaining.

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

public FunnelBreakdown.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FunnelBreakdown.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FunnelBreakdown.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunnelBreakdown.Builder
Overrides