Package io.deephaven.proto.pivot

Class PivotTableDescriptorMessage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

io.deephaven.proto.pivot.PivotTableDescriptorMessage.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, PivotTableDescriptorMessageOrBuilder, Cloneable

Enclosing class:

PivotTableDescriptorMessage

public static final class PivotTableDescriptorMessage.Builder
extends GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>
implements PivotTableDescriptorMessageOrBuilder

Protobuf type io.deephaven.proto.pivot.PivotTableDescriptorMessage

Method Summary

Modifier and Type	Method	Description
PivotTableDescriptorMessage.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)	Like setRepeatedField, but appends the value as a new element.
PivotTableDescriptorMessage	build()	Constructs the message based on the state of the Builder.
PivotTableDescriptorMessage	buildPartial()	Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
PivotTableDescriptorMessage.Builder	clear()	Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
PivotTableDescriptorMessage.Builder	clearField(Descriptors.FieldDescriptor field)	Clears the field.
PivotTableDescriptorMessage.Builder	clearIsStatic()	Whether or not this table might change.
PivotTableDescriptorMessage.Builder	clearOneof(Descriptors.OneofDescriptor oneof)	TODO: Clear it when all subclasses have implemented this method.
PivotTableDescriptorMessage.Builder	clearSnapshotSchema()	Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
PivotTableDescriptorMessage.Builder	clone()	Clones the Builder.
PivotTableDescriptorMessage	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static final Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
boolean	getIsStatic()	Whether or not this table might change.
ByteString	getSnapshotSchema()	Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
final boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
PivotTableDescriptorMessage.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)	Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
PivotTableDescriptorMessage.Builder	mergeFrom(Message other)	Merge other into the message being built.
PivotTableDescriptorMessage.Builder	mergeFrom(PivotTableDescriptorMessage other)
final PivotTableDescriptorMessage.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)	Merge some unknown fields into the UnknownFieldSet for this message.
PivotTableDescriptorMessage.Builder	setField(Descriptors.FieldDescriptor field, Object value)	Sets a field to the given value.
PivotTableDescriptorMessage.Builder	setIsStatic(boolean value)	Whether or not this table might change.
PivotTableDescriptorMessage.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)	Sets an element of a repeated field to the given value.
PivotTableDescriptorMessage.Builder	setSnapshotSchema(ByteString value)	Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
final PivotTableDescriptorMessage.Builder	setUnknownFields(UnknownFieldSet unknownFields)	Set the UnknownFieldSet for this message.

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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, 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.MessageOrBuilder

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

Method Details

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: com.google.protobuf.GeneratedMessageV3.Builder

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

clear

public PivotTableDescriptorMessage.Builder clear()

Description copied from class: com.google.protobuf.GeneratedMessageV3.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: com.google.protobuf.Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

getDefaultInstanceForType

public PivotTableDescriptorMessage getDefaultInstanceForType()

Description copied from interface: com.google.protobuf.MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public PivotTableDescriptorMessage build()

Description copied from interface: com.google.protobuf.MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public PivotTableDescriptorMessage buildPartial()

Description copied from interface: com.google.protobuf.MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public PivotTableDescriptorMessage.Builder clone()

Description copied from interface: com.google.protobuf.MessageLite.Builder

Clones the Builder.

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

See Also:

• Object.clone()

setField

public PivotTableDescriptorMessage.Builder setField(Descriptors.FieldDescriptor field,
 Object value)

Description copied from interface: com.google.protobuf.Message.Builder

Sets a field to the given value. The value must be of the correct type for this field, that is, the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) returns.

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

clearField

public PivotTableDescriptorMessage.Builder clearField(Descriptors.FieldDescriptor field)

Description copied from interface: com.google.protobuf.Message.Builder

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

clearOneof

public PivotTableDescriptorMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Description copied from class: com.google.protobuf.AbstractMessage.Builder

TODO: Clear it when all subclasses have implemented this method.

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

setRepeatedField

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

Description copied from interface: com.google.protobuf.Message.Builder

Sets an element of a repeated field to the given value. The value must be of the correct type for this field; that is, the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) returns.

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

addRepeatedField

public PivotTableDescriptorMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field,
 Object value)

Description copied from interface: com.google.protobuf.Message.Builder

Like setRepeatedField, but appends the value as a new element.

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

mergeFrom

public PivotTableDescriptorMessage.Builder mergeFrom(Message other)

Description copied from interface: com.google.protobuf.Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PivotTableDescriptorMessage.Builder>

mergeFrom

public PivotTableDescriptorMessage.Builder mergeFrom(PivotTableDescriptorMessage other)

isInitialized

public final boolean isInitialized()

Description copied from interface: com.google.protobuf.MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder#getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

mergeFrom

public PivotTableDescriptorMessage.Builder mergeFrom(CodedInputStream input,
 ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Description copied from interface: com.google.protobuf.MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<PivotTableDescriptorMessage.Builder>

Throws:

InvalidProtocolBufferException - the bytes read are not syntactically correct according to the protobuf wire format specification. The data is corrupt, incomplete, or was never a protobuf in the first place.

IOException - an I/O error reading from the stream

getSnapshotSchema

public ByteString getSnapshotSchema()

 Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

  "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
  but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
  displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
     a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
  have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
  was used as input to this column. May have an empty value, because some aggregations take no input columns, for
  example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
  "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
 

bytes snapshot_schema = 1;

Specified by:

getSnapshotSchema in interface PivotTableDescriptorMessageOrBuilder

Returns:

The snapshotSchema.

setSnapshotSchema

public PivotTableDescriptorMessage.Builder setSnapshotSchema(ByteString value)

 Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

  "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
  but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
  displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
     a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
  have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
  was used as input to this column. May have an empty value, because some aggregations take no input columns, for
  example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
  "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
 

bytes snapshot_schema = 1;

Parameters:

value - The snapshotSchema to set.

Returns:

This builder for chaining.

clearSnapshotSchema

public PivotTableDescriptorMessage.Builder clearSnapshotSchema()

 Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the PivotTable, the
 special roles some columns play, and the relationships between columns.

 All schema metadata for pivots is prefixed with "deephaven:".  Most values are a boolean tag (represented as the
 string "true" if set that indicate which type of column this is.

  "pivotTable.isStructuralColumn" set on columns that should be included on every snapshot or subscription request,
  but should not be directly user-visible.

 "pivotTable.isRowExpandByColumn" is set on all the columns that must be included in a PivotTableViewRequest's row key table. These columns are generally user-visible and
  displayed before other columns, unless they also have {@value PIVOT_TABLE_IS_STRUCTURAL_COLUMN} set.

 "pivotTable.isRowDepthColumn"  is set on a single column that specifies the depth of
     a row. That column will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowExpandedColumn" is set on a single nullable column of booleans that
 specifies whether a row is expandable or expanded. Values will be null for rows that are not expandable, true for
 expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no children to expand, and
 hence will always have a null value for this column.

 "pivotTable.isRowGroupByColumn" is set on all columns of a pivot that are row
 by-columns Such columns will always have pivotTable.isRowExpandByColumn set.

 "pivotTable.isRowValueColumn" is set on all columns that are totals for a given row.

 The Column dimension has an equivalent set of attributes as rows:
 "pivotTable.isColumnExpandByColumn"
 "pivotTable.isColumnDepthColumn"
 "pivotTable.isColumnExpandedColumn"
 "pivotTable.isColumnGroupByColumn"
 "pivotTable.isColumnValueColumn"

 "pivotTable.isGrandTotalValueColumn" is set on all columns that are a grand total the given  table.  These columns
  have only one value for the entire snapshot that represents the aggregation across the entire source table.

 "pivotTable.isValueColumn" is set on all columns that are part of the main field (grid) of values.

 "pivotTable.aggregationInputColumnName" is set to the name of the corresponding constituent column that
  was used as input to this column. May have an empty value, because some aggregations take no input columns, for
  example, "Count". This is only ever present on columns with "pivotTable.isValueColumn"
  "pivotTable.isRowValueColumn",  "pivotTable.isColumnValueColumn" or "pivotTable.isGrandTotalValueColumn" set.
 

bytes snapshot_schema = 1;

Returns:

This builder for chaining.

getIsStatic

public boolean getIsStatic()

 Whether or not this table might change.
 

bool is_static = 2;

Specified by:

getIsStatic in interface PivotTableDescriptorMessageOrBuilder

Returns:

The isStatic.

setIsStatic

public PivotTableDescriptorMessage.Builder setIsStatic(boolean value)

 Whether or not this table might change.
 

bool is_static = 2;

Parameters:

value - The isStatic to set.

Returns:

This builder for chaining.

clearIsStatic

public PivotTableDescriptorMessage.Builder clearIsStatic()

 Whether or not this table might change.
 

bool is_static = 2;

Returns:

This builder for chaining.

setUnknownFields

public final PivotTableDescriptorMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: com.google.protobuf.Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>

mergeUnknownFields

public final PivotTableDescriptorMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: com.google.protobuf.Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<PivotTableDescriptorMessage.Builder>