Class SamplingMetadata (0.47.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
TypeDescription
int

SAMPLING_SPACE_SIZE_FIELD_NUMBER

public static final int SAMPLING_SPACE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SamplingMetadata getDefaultInstance()
Returns
TypeDescription
SamplingMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SamplingMetadata.Builder newBuilder()
Returns
TypeDescription
SamplingMetadata.Builder

newBuilder(SamplingMetadata prototype)

public static SamplingMetadata.Builder newBuilder(SamplingMetadata prototype)
Parameter
NameDescription
prototypeSamplingMetadata
Returns
TypeDescription
SamplingMetadata.Builder

parseDelimitedFrom(InputStream input)

public static SamplingMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SamplingMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SamplingMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SamplingMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SamplingMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SamplingMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SamplingMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SamplingMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SamplingMetadata> parser()
Returns
TypeDescription
Parser<SamplingMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SamplingMetadata getDefaultInstanceForType()
Returns
TypeDescription
SamplingMetadata

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SamplingMetadata.Builder newBuilderForType()
Returns
TypeDescription
SamplingMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SamplingMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SamplingMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SamplingMetadata.Builder toBuilder()
Returns
TypeDescription
SamplingMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException