Class SamplingMetadata (0.57.0)

public final class SamplingMetadata extends GeneratedMessageV3 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 Fields

SAMPLES_READ_COUNT_FIELD_NUMBER

public static final int SAMPLES_READ_COUNT_FIELD_NUMBER
Field Value
Type Description
int

SAMPLING_SPACE_SIZE_FIELD_NUMBER

public static final int SAMPLING_SPACE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SamplingMetadata getDefaultInstance()
Returns
Type Description
SamplingMetadata

getDescriptor()

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

newBuilder()

public static SamplingMetadata.Builder newBuilder()
Returns
Type Description
SamplingMetadata.Builder

newBuilder(SamplingMetadata prototype)

public static SamplingMetadata.Builder newBuilder(SamplingMetadata prototype)
Parameter
Name Description
prototype SamplingMetadata
Returns
Type Description
SamplingMetadata.Builder

parseDelimitedFrom(InputStream input)

public static SamplingMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SamplingMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SamplingMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SamplingMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SamplingMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SamplingMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SamplingMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SamplingMetadata> parser()
Returns
Type Description
Parser<SamplingMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SamplingMetadata getDefaultInstanceForType()
Returns
Type Description
SamplingMetadata

getParserForType()

public Parser<SamplingMetadata> getParserForType()
Returns
Type Description
Parser<SamplingMetadata>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SamplingMetadata.Builder newBuilderForType()
Returns
Type Description
SamplingMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SamplingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SamplingMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SamplingMetadata.Builder toBuilder()
Returns
Type Description
SamplingMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException