Class SamplingMetadata.Builder (0.53.0)

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

If this report results is sampled, this describes the percentage of events used in this report. 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.v1beta.SamplingMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SamplingMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
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 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 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 report, compute samplesReadCount/samplingSpaceSize.

int64 sampling_space_size = 2;

Returns
Type Description
SamplingMetadata.Builder

This builder for chaining.

clone()

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

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 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 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 report, compute samplesReadCount/samplingSpaceSize.

int64 sampling_space_size = 2;

Returns
Type Description
long

The samplingSpaceSize.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

public SamplingMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
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 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 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 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.

setUnknownFields(UnknownFieldSet unknownFields)

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