Class Aggregation (0.37.0)

public final class Aggregation extends GeneratedMessageV3 implements AggregationOrBuilder

Message describing an aggregation. The message includes the aggregation type, parameters, and the field on which to perform the aggregation.

Protobuf type google.cloud.migrationcenter.v1.Aggregation

Static Fields

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER
Field Value
Type Description
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

FREQUENCY_FIELD_NUMBER

public static final int FREQUENCY_FIELD_NUMBER
Field Value
Type Description
int

HISTOGRAM_FIELD_NUMBER

public static final int HISTOGRAM_FIELD_NUMBER
Field Value
Type Description
int

SUM_FIELD_NUMBER

public static final int SUM_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Aggregation getDefaultInstance()
Returns
Type Description
Aggregation

getDescriptor()

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

newBuilder()

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

newBuilder(Aggregation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAggregationFunctionCase()

public Aggregation.AggregationFunctionCase getAggregationFunctionCase()
Returns
Type Description
Aggregation.AggregationFunctionCase

getCount()

public Aggregation.Count getCount()

Count the number of matching objects.

.google.cloud.migrationcenter.v1.Aggregation.Count count = 2;

Returns
Type Description
Aggregation.Count

The count.

getCountOrBuilder()

public Aggregation.CountOrBuilder getCountOrBuilder()

Count the number of matching objects.

.google.cloud.migrationcenter.v1.Aggregation.Count count = 2;

Returns
Type Description
Aggregation.CountOrBuilder

getDefaultInstanceForType()

public Aggregation getDefaultInstanceForType()
Returns
Type Description
Aggregation

getField()

public String getField()

The name of the field on which to aggregate.

string field = 1;

Returns
Type Description
String

The field.

getFieldBytes()

public ByteString getFieldBytes()

The name of the field on which to aggregate.

string field = 1;

Returns
Type Description
ByteString

The bytes for field.

getFrequency()

public Aggregation.Frequency getFrequency()

Creates a frequency distribution of all field values.

.google.cloud.migrationcenter.v1.Aggregation.Frequency frequency = 5;

Returns
Type Description
Aggregation.Frequency

The frequency.

getFrequencyOrBuilder()

public Aggregation.FrequencyOrBuilder getFrequencyOrBuilder()

Creates a frequency distribution of all field values.

.google.cloud.migrationcenter.v1.Aggregation.Frequency frequency = 5;

Returns
Type Description
Aggregation.FrequencyOrBuilder

getHistogram()

public Aggregation.Histogram getHistogram()

Creates a bucketed histogram of field values.

.google.cloud.migrationcenter.v1.Aggregation.Histogram histogram = 4;

Returns
Type Description
Aggregation.Histogram

The histogram.

getHistogramOrBuilder()

public Aggregation.HistogramOrBuilder getHistogramOrBuilder()

Creates a bucketed histogram of field values.

.google.cloud.migrationcenter.v1.Aggregation.Histogram histogram = 4;

Returns
Type Description
Aggregation.HistogramOrBuilder

getParserForType()

public Parser<Aggregation> getParserForType()
Returns
Type Description
Parser<Aggregation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSum()

public Aggregation.Sum getSum()

Sum over a numeric field.

.google.cloud.migrationcenter.v1.Aggregation.Sum sum = 3;

Returns
Type Description
Aggregation.Sum

The sum.

getSumOrBuilder()

public Aggregation.SumOrBuilder getSumOrBuilder()

Sum over a numeric field.

.google.cloud.migrationcenter.v1.Aggregation.Sum sum = 3;

Returns
Type Description
Aggregation.SumOrBuilder

hasCount()

public boolean hasCount()

Count the number of matching objects.

.google.cloud.migrationcenter.v1.Aggregation.Count count = 2;

Returns
Type Description
boolean

Whether the count field is set.

hasFrequency()

public boolean hasFrequency()

Creates a frequency distribution of all field values.

.google.cloud.migrationcenter.v1.Aggregation.Frequency frequency = 5;

Returns
Type Description
boolean

Whether the frequency field is set.

hasHistogram()

public boolean hasHistogram()

Creates a bucketed histogram of field values.

.google.cloud.migrationcenter.v1.Aggregation.Histogram histogram = 4;

Returns
Type Description
boolean

Whether the histogram field is set.

hasSum()

public boolean hasSum()

Sum over a numeric field.

.google.cloud.migrationcenter.v1.Aggregation.Sum sum = 3;

Returns
Type Description
boolean

Whether the sum field is set.

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 Aggregation.Builder newBuilderForType()
Returns
Type Description
Aggregation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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