Class FunnelResponseMetadata.Builder (0.57.0)

public static final class FunnelResponseMetadata.Builder extends GeneratedMessageV3.Builder<FunnelResponseMetadata.Builder> implements FunnelResponseMetadataOrBuilder

The funnel report's response metadata carries additional information about the funnel report.

Protobuf type google.analytics.data.v1alpha.FunnelResponseMetadata

Static Methods

getDescriptor()

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

Methods

addAllSamplingMetadatas(Iterable<? extends SamplingMetadata> values)

public FunnelResponseMetadata.Builder addAllSamplingMetadatas(Iterable<? extends SamplingMetadata> values)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
values Iterable<? extends com.google.analytics.data.v1alpha.SamplingMetadata>
Returns
Type Description
FunnelResponseMetadata.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSamplingMetadatas(SamplingMetadata value)

public FunnelResponseMetadata.Builder addSamplingMetadatas(SamplingMetadata value)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
value SamplingMetadata
Returns
Type Description
FunnelResponseMetadata.Builder

addSamplingMetadatas(SamplingMetadata.Builder builderForValue)

public FunnelResponseMetadata.Builder addSamplingMetadatas(SamplingMetadata.Builder builderForValue)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
builderForValue SamplingMetadata.Builder
Returns
Type Description
FunnelResponseMetadata.Builder

addSamplingMetadatas(int index, SamplingMetadata value)

public FunnelResponseMetadata.Builder addSamplingMetadatas(int index, SamplingMetadata value)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameters
Name Description
index int
value SamplingMetadata
Returns
Type Description
FunnelResponseMetadata.Builder

addSamplingMetadatas(int index, SamplingMetadata.Builder builderForValue)

public FunnelResponseMetadata.Builder addSamplingMetadatas(int index, SamplingMetadata.Builder builderForValue)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameters
Name Description
index int
builderForValue SamplingMetadata.Builder
Returns
Type Description
FunnelResponseMetadata.Builder

addSamplingMetadatasBuilder()

public SamplingMetadata.Builder addSamplingMetadatasBuilder()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
SamplingMetadata.Builder

addSamplingMetadatasBuilder(int index)

public SamplingMetadata.Builder addSamplingMetadatasBuilder(int index)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadata.Builder

build()

public FunnelResponseMetadata build()
Returns
Type Description
FunnelResponseMetadata

buildPartial()

public FunnelResponseMetadata buildPartial()
Returns
Type Description
FunnelResponseMetadata

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSamplingMetadatas()

public FunnelResponseMetadata.Builder clearSamplingMetadatas()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
FunnelResponseMetadata.Builder

clone()

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

getDefaultInstanceForType()

public FunnelResponseMetadata getDefaultInstanceForType()
Returns
Type Description
FunnelResponseMetadata

getDescriptorForType()

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

getSamplingMetadatas(int index)

public SamplingMetadata getSamplingMetadatas(int index)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadata

getSamplingMetadatasBuilder(int index)

public SamplingMetadata.Builder getSamplingMetadatasBuilder(int index)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadata.Builder

getSamplingMetadatasBuilderList()

public List<SamplingMetadata.Builder> getSamplingMetadatasBuilderList()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
List<Builder>

getSamplingMetadatasCount()

public int getSamplingMetadatasCount()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
int

getSamplingMetadatasList()

public List<SamplingMetadata> getSamplingMetadatasList()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
List<SamplingMetadata>

getSamplingMetadatasOrBuilder(int index)

public SamplingMetadataOrBuilder getSamplingMetadatasOrBuilder(int index)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
index int
Returns
Type Description
SamplingMetadataOrBuilder

getSamplingMetadatasOrBuilderList()

public List<? extends SamplingMetadataOrBuilder> getSamplingMetadatasOrBuilderList()

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Returns
Type Description
List<? extends com.google.analytics.data.v1alpha.SamplingMetadataOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FunnelResponseMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeSamplingMetadatas(int index)

public FunnelResponseMetadata.Builder removeSamplingMetadatas(int index)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameter
Name Description
index int
Returns
Type Description
FunnelResponseMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSamplingMetadatas(int index, SamplingMetadata value)

public FunnelResponseMetadata.Builder setSamplingMetadatas(int index, SamplingMetadata value)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameters
Name Description
index int
value SamplingMetadata
Returns
Type Description
FunnelResponseMetadata.Builder

setSamplingMetadatas(int index, SamplingMetadata.Builder builderForValue)

public FunnelResponseMetadata.Builder setSamplingMetadatas(int index, SamplingMetadata.Builder builderForValue)

If funnel report results are sampled, this describes what percentage of events were used in this funnel report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1alpha.SamplingMetadata sampling_metadatas = 1;

Parameters
Name Description
index int
builderForValue SamplingMetadata.Builder
Returns
Type Description
FunnelResponseMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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