Class SamplingMetadata.Builder (0.94.0)

public static final class SamplingMetadata.Builder extends GeneratedMessage.Builder<SamplingMetadata.Builder> implements SamplingMetadataOrBuilder

If funnel report results are sampled, this metadata describes what percentage of events were used in this funnel report for a date range. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set.

Protobuf type google.analytics.data.v1alpha.SamplingMetadata

Static Methods

getDescriptor()

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

Methods

build()

public SamplingMetadata build()
Returns
Type Description
SamplingMetadata

buildPartial()

public SamplingMetadata buildPartial()
Returns
Type Description
SamplingMetadata

clear()

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

clearSamplesReadCount()

public SamplingMetadata.Builder clearSamplesReadCount()

The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this funnel report.

int64 samples_read_count = 1;

Returns
Type Description
SamplingMetadata.Builder

This builder for chaining.

clearSamplingSpaceSize()

public SamplingMetadata.Builder clearSamplingSpaceSize()

The total number of events present in this property's data that could have been analyzed in this funnel report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set.

To calculate the percentage of available data that was used in this funnel report, compute samplesReadCount/samplingSpaceSize.

int64 sampling_space_size = 2;

Returns
Type Description
SamplingMetadata.Builder

This builder for chaining.

getDefaultInstanceForType()

public SamplingMetadata getDefaultInstanceForType()
Returns
Type Description
SamplingMetadata

getDescriptorForType()

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

getSamplesReadCount()

public long getSamplesReadCount()

The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this funnel report.

int64 samples_read_count = 1;

Returns
Type Description
long

The samplesReadCount.

getSamplingSpaceSize()

public long getSamplingSpaceSize()

The total number of events present in this property's data that could have been analyzed in this funnel report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set.

To calculate the percentage of available data that was used in this funnel report, compute samplesReadCount/samplingSpaceSize.

int64 sampling_space_size = 2;

Returns
Type Description
long

The samplingSpaceSize.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SamplingMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setSamplesReadCount(long value)

public SamplingMetadata.Builder setSamplesReadCount(long value)

The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this funnel report.

int64 samples_read_count = 1;

Parameter
Name Description
value long

The samplesReadCount to set.

Returns
Type Description
SamplingMetadata.Builder

This builder for chaining.

setSamplingSpaceSize(long value)

public SamplingMetadata.Builder setSamplingSpaceSize(long value)

The total number of events present in this property's data that could have been analyzed in this funnel report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set.

To calculate the percentage of available data that was used in this funnel report, compute samplesReadCount/samplingSpaceSize.

int64 sampling_space_size = 2;

Parameter
Name Description
value long

The samplingSpaceSize to set.

Returns
Type Description
SamplingMetadata.Builder

This builder for chaining.