Class SamplingMetadata.Builder (0.48.0)

public static final class SamplingMetadata.Builder extends GeneratedMessageV3.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SamplingMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

build()

public SamplingMetadata build()
Returns
TypeDescription
SamplingMetadata

buildPartial()

public SamplingMetadata buildPartial()
Returns
TypeDescription
SamplingMetadata

clear()

public SamplingMetadata.Builder clear()
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SamplingMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SamplingMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
SamplingMetadata.Builder

This builder for chaining.

clone()

public SamplingMetadata.Builder clone()
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

getDefaultInstanceForType()

public SamplingMetadata getDefaultInstanceForType()
Returns
TypeDescription
SamplingMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
long

The samplingSpaceSize.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SamplingMetadata other)

public SamplingMetadata.Builder mergeFrom(SamplingMetadata other)
Parameter
NameDescription
otherSamplingMetadata
Returns
TypeDescription
SamplingMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SamplingMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SamplingMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SamplingMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SamplingMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

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

public SamplingMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valuelong

The samplesReadCount to set.

Returns
TypeDescription
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
NameDescription
valuelong

The samplingSpaceSize to set.

Returns
TypeDescription
SamplingMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SamplingMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SamplingMetadata.Builder
Overrides