Package com.google.analytics.data.v1alpha

Class SamplingMetadata.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder>
com.google.analytics.data.v1alpha.SamplingMetadata.Builder
All Implemented Interfaces:
SamplingMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SamplingMetadata
public static final class SamplingMetadata.Builder extends com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder> implements SamplingMetadataOrBuilder
 If funnel report results are
 [sampled](https://support.google.com/analytics/answer/13331292), 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

  • Method Summary

    Modifier and Type
    Method
    Description
    SamplingMetadata
    build()
     
    SamplingMetadata
    buildPartial()
     
    SamplingMetadata.Builder
    clear()
     
    SamplingMetadata.Builder
    clearSamplesReadCount()
    The total number of events read in this sampled report for a date range.
    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.
    SamplingMetadata
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    long
    getSamplesReadCount()
    The total number of events read in this sampled report for a date range.
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    SamplingMetadata.Builder
    mergeFrom(SamplingMetadata other)
     
    SamplingMetadata.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    SamplingMetadata.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    SamplingMetadata.Builder
    setSamplesReadCount(long value)
    The total number of events read in this sampled report for a date range.
    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.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder>

    • clear

      public SamplingMetadata.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder>

    • getDefaultInstanceForType

      public SamplingMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SamplingMetadata build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SamplingMetadata buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SamplingMetadata.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SamplingMetadata.Builder>

    • mergeFrom

      public SamplingMetadata.Builder mergeFrom(SamplingMetadata other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SamplingMetadata.Builder>

    • mergeFrom

      public SamplingMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SamplingMetadata.Builder>
      Throws:
      IOException

    • 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;
      Specified by:
      getSamplesReadCount in interface SamplingMetadataOrBuilder
      Returns:
      The samplesReadCount.

    • setSamplesReadCount

      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;
      Parameters:
      value - The samplesReadCount to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.

    • 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;
      Specified by:
      getSamplingSpaceSize in interface SamplingMetadataOrBuilder
      Returns:
      The samplingSpaceSize.

    • setSamplingSpaceSize

      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;
      Parameters:
      value - The samplingSpaceSize to set.
      Returns:
      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:
      This builder for chaining.