deephaven_enterprise.proto.pivot.pivottable_pb2¶

Module Contents¶

class ErrorResponse(*, error_message=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: error_message (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ERROR_MESSAGE_FIELD_NUMBER: int[source]¶

error_message: str[source]¶

class PivotPluginRequest(*, request_id=..., view=..., export_source=..., empty_expansions=..., creation=..., apply=..., get_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

We have not created a service, but rather make a request using the oneof message; and reply using the corresponding message in the PivotPluginResponse. The PivotServicePlugin then has a switch statement for dispatch rather than using the service.

Parameters:

request_id (str)
view (Global___PivotTableViewRequest | None)
export_source (Global___PivotTableSourceExportRequest | None)
empty_expansions (Global___PivotTableEmptyExpansionsRequest | None)
creation (Global___PivotTableCreationRequest | None)
apply (Global___PivotTableApplyRequest | None)
get_descriptor (Global___PivotTableDescriptorRequest | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

APPLY_FIELD_NUMBER: int[source]¶

CREATION_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EMPTY_EXPANSIONS_FIELD_NUMBER: int[source]¶

EXPORT_SOURCE_FIELD_NUMBER: int[source]¶

GET_DESCRIPTOR_FIELD_NUMBER: int[source]¶

REQUEST_ID_FIELD_NUMBER: int[source]¶

VIEW_FIELD_NUMBER: int[source]¶

property apply: Global___PivotTableApplyRequest[source]¶

Return type:: Global___PivotTableApplyRequest

property creation: Global___PivotTableCreationRequest[source]¶

Return type:: Global___PivotTableCreationRequest

property empty_expansions: Global___PivotTableEmptyExpansionsRequest[source]¶

Return type:: Global___PivotTableEmptyExpansionsRequest

property export_source: Global___PivotTableSourceExportRequest[source]¶

Return type:: Global___PivotTableSourceExportRequest

property get_descriptor: Global___PivotTableDescriptorRequest[source]¶

Return type:: Global___PivotTableDescriptorRequest

request_id: str[source]¶: A client-specified identifier used to identify the response for this request when multiple requests are in flight. This must be set to a unique value.

property view: Global___PivotTableViewRequest[source]¶

Return type:: Global___PivotTableViewRequest

class PivotPluginResponse(*, request_id=..., error=..., view=..., export=..., empty_expansions=..., creation=..., apply=..., get_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

request_id (str)
error (Global___ErrorResponse | None)
view (Global___PivotTableViewResponse | None)
export (Global___PivotTableSourceExportResponse | None)
empty_expansions (Global___PivotTableEmptyExpansionsResponse | None)
creation (Global___PivotTableCreationResponse | None)
apply (Global___PivotTableApplyResponse | None)
get_descriptor (Global___PivotTableDescriptorResponse | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

APPLY_FIELD_NUMBER: int[source]¶

CREATION_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EMPTY_EXPANSIONS_FIELD_NUMBER: int[source]¶

ERROR_FIELD_NUMBER: int[source]¶

EXPORT_FIELD_NUMBER: int[source]¶

GET_DESCRIPTOR_FIELD_NUMBER: int[source]¶

REQUEST_ID_FIELD_NUMBER: int[source]¶

VIEW_FIELD_NUMBER: int[source]¶

property apply: Global___PivotTableApplyResponse[source]¶

Return type:: Global___PivotTableApplyResponse

property creation: Global___PivotTableCreationResponse[source]¶

Return type:: Global___PivotTableCreationResponse

property empty_expansions: Global___PivotTableEmptyExpansionsResponse[source]¶

Return type:: Global___PivotTableEmptyExpansionsResponse

property error: Global___ErrorResponse[source]¶

If the request failed (after we were able to parse and extract the request ID), then we return an error to the client; otherwise we return the appropriate response type.

Return type:: Global___ErrorResponse

property export: Global___PivotTableSourceExportResponse[source]¶

Return type:: Global___PivotTableSourceExportResponse

property get_descriptor: Global___PivotTableDescriptorResponse[source]¶

Return type:: Global___PivotTableDescriptorResponse

request_id: str[source]¶: Identifier copied from the request.

property view: Global___PivotTableViewResponse[source]¶

Return type:: Global___PivotTableViewResponse

class PivotTableApplyRequest(*, row_sorts=..., column_sorts=..., filters=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

row_sorts (collections.abc.Iterable[deephaven_core.proto.table_pb2.SortDescriptor] | None)
column_sorts (collections.abc.Iterable[deephaven_core.proto.table_pb2.SortDescriptor] | None)
filters (collections.abc.Iterable[deephaven_core.proto.table_pb2.Condition] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COLUMN_SORTS_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

FILTERS_FIELD_NUMBER: int[source]¶

ROW_SORTS_FIELD_NUMBER: int[source]¶

property column_sorts: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.SortDescriptor][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.SortDescriptor]

property filters: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.Condition][source]¶

The filters must be against the grouping columns (either row or columns)

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.Condition]

property row_sorts: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.SortDescriptor][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.SortDescriptor]

class PivotTableApplyResponse(*, pivot_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: pivot_descriptor (Global___PivotTableDescriptorMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PIVOT_DESCRIPTOR_FIELD_NUMBER: int[source]¶

property pivot_descriptor: Global___PivotTableDescriptorMessage[source]¶

first reference is the new pivot table

Return type:: Global___PivotTableDescriptorMessage

class PivotTableCreationRequest(*, aggregations=..., row_keys=..., column_keys=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

aggregations (collections.abc.Iterable[deephaven_core.proto.table_pb2.Aggregation] | None)
row_keys (collections.abc.Iterable[str] | None)
column_keys (collections.abc.Iterable[str] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

AGGREGATIONS_FIELD_NUMBER: int[source]¶

COLUMN_KEYS_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ROW_KEYS_FIELD_NUMBER: int[source]¶

property aggregations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.Aggregation][source]¶

aggregations for the values

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_core.proto.table_pb2.Aggregation]

property column_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

first reference is the input table

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property row_keys: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class PivotTableCreationResponse(*, pivot_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: pivot_descriptor (Global___PivotTableDescriptorMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PIVOT_DESCRIPTOR_FIELD_NUMBER: int[source]¶

property pivot_descriptor: Global___PivotTableDescriptorMessage[source]¶

first reference is the created pivot table

Return type:: Global___PivotTableDescriptorMessage

class PivotTableDescriptorMessage(*, snapshot_schema=..., is_static=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

snapshot_schema (bytes)
is_static (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

IS_STATIC_FIELD_NUMBER: int[source]¶

SNAPSHOT_SCHEMA_FIELD_NUMBER: int[source]¶

is_static: bool[source]¶: Whether or not this table might change.

snapshot_schema: bytes[source]¶

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.

class PivotTableDescriptorRequest[source]¶

Bases: google.protobuf.message.Message

the first object is the pivot table

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PivotTableDescriptorResponse(*, pivot_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: pivot_descriptor (Global___PivotTableDescriptorMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PIVOT_DESCRIPTOR_FIELD_NUMBER: int[source]¶

property pivot_descriptor: Global___PivotTableDescriptorMessage[source]¶

The description of the table

Return type:: Global___PivotTableDescriptorMessage

class PivotTableEmptyExpansionsRequest[source]¶

Bases: google.protobuf.message.Message

the first object is the pivot table

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PivotTableEmptyExpansionsResponse[source]¶

Bases: google.protobuf.message.Message

the first object is the result rows expansion table the second object is the result columns expansion table

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PivotTableSourceExportRequest[source]¶

Bases: google.protobuf.message.Message

the first object is the pivot table

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PivotTableSourceExportResponse[source]¶

Bases: google.protobuf.message.Message

the first object is the result source table

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PivotTableViewExpansionsMessage(*, row_key_table_offset=..., row_key_table_action_column=..., column_key_table_offset=..., column_key_table_action_column=..., output_columns=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

row_key_table_offset (int | None)
row_key_table_action_column (str | None)
column_key_table_offset (int | None)
column_key_table_action_column (str | None)
output_columns (collections.abc.Iterable[str] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_column_key_table_action_column', b'_column_key_table_action_column']) → Literal['column_key_table_action_column'] | None[source]¶

WhichOneof(oneof_group: Literal['_column_key_table_offset', b'_column_key_table_offset']) → Literal['column_key_table_offset'] | None

WhichOneof(oneof_group: Literal['_row_key_table_action_column', b'_row_key_table_action_column']) → Literal['row_key_table_action_column'] | None

WhichOneof(oneof_group: Literal['_row_key_table_offset', b'_row_key_table_offset']) → Literal['row_key_table_offset'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

COLUMN_KEY_TABLE_ACTION_COLUMN_FIELD_NUMBER: int[source]¶

COLUMN_KEY_TABLE_OFFSET_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

OUTPUT_COLUMNS_FIELD_NUMBER: int[source]¶

ROW_KEY_TABLE_ACTION_COLUMN_FIELD_NUMBER: int[source]¶

ROW_KEY_TABLE_OFFSET_FIELD_NUMBER: int[source]¶

column_key_table_action_column: str[source]¶: The name of a column of bytes found in the key table that specifies the action desired for the node selected by the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be expanded along with their descendants, and 4 for nodes that should be contracted. If this column name is not present, all nodes in the key table will be expanded without their descendants.

column_key_table_offset: int[source]¶: Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable). The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is expected to have one column for each “expand-by column”, including the “row depth column” for RollupTables only, and (optionally) an “action” column whose name is specified in the key_table_action_column field. If the Table is empty the result will have only default nodes expanded.

property output_columns: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

The name of the output columns that are sent, if not specified then all totals and value columns are sent.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

row_key_table_action_column: str[source]¶: The name of a column of bytes found in the key table that specifies the action desired for the node selected by the other columns for each row. Takes on the value 1 for nodes that should be expanded, 3 for nodes that should be expanded along with their descendants, and 4 for nodes that should be contracted. If this column name is not present, all nodes in the key table will be expanded without their descendants.

row_key_table_offset: int[source]¶: Offset (in the references) of a Table of expanded or contracted keys from a PivotTable (RollupTable or TreeTable). The format for the key Table is dictated by the schema from the corresponding PivotTableDescriptor. It is expected to have one column for each “expand-by column”, including the “row depth column” for RollupTables only, and (optionally) an “action” column whose name is specified in the key_table_action_column field. If the Table is empty the result will have only default nodes expanded.

class PivotTableViewRequest(*, pivot_table_offset=..., existing_view_offset=..., expansions=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

pivot_table_offset (int)
existing_view_offset (int)
expansions (Global___PivotTableViewExpansionsMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EXISTING_VIEW_OFFSET_FIELD_NUMBER: int[source]¶

EXPANSIONS_FIELD_NUMBER: int[source]¶

PIVOT_TABLE_OFFSET_FIELD_NUMBER: int[source]¶

existing_view_offset: int[source]¶: Offset of the existing PivotTableView in the incoming plugin references array. The result view will inherit the PivotTable from the existing view. The two views will share state used for caching snapshot data, but the server implementation may limit parallelism when performing snapshots for either view. Use this field when you intend to stop using the existing view and instead begin to use the result view.

property expansions: Global___PivotTableViewExpansionsMessage[source]¶

Description for the expansions that define this view of the PivotTable. If not present, the result will have default expansions.

Return type:: Global___PivotTableViewExpansionsMessage

pivot_table_offset: int[source]¶: Offset of the pivot table in the incoming plugin references.

class PivotTableViewResponse(*, pivot_descriptor=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: pivot_descriptor (Global___PivotTableDescriptorMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PIVOT_DESCRIPTOR_FIELD_NUMBER: int[source]¶

property pivot_descriptor: Global___PivotTableDescriptorMessage[source]¶

The description of the table The first object in the references is the PivotTableView result

Return type:: Global___PivotTableDescriptorMessage

DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]¶

type Global___ErrorResponse = ErrorResponse[source]¶

type Global___PivotPluginRequest = PivotPluginRequest[source]¶

type Global___PivotPluginResponse = PivotPluginResponse[source]¶

type Global___PivotTableApplyRequest = PivotTableApplyRequest[source]¶

type Global___PivotTableApplyResponse = PivotTableApplyResponse[source]¶

type Global___PivotTableCreationRequest = PivotTableCreationRequest[source]¶

type Global___PivotTableCreationResponse = PivotTableCreationResponse[source]¶

type Global___PivotTableDescriptorMessage = PivotTableDescriptorMessage[source]¶

type Global___PivotTableDescriptorRequest = PivotTableDescriptorRequest[source]¶

type Global___PivotTableDescriptorResponse = PivotTableDescriptorResponse[source]¶

type Global___PivotTableEmptyExpansionsRequest = PivotTableEmptyExpansionsRequest[source]¶

type Global___PivotTableEmptyExpansionsResponse = PivotTableEmptyExpansionsResponse[source]¶

type Global___PivotTableSourceExportRequest = PivotTableSourceExportRequest[source]¶

type Global___PivotTableSourceExportResponse = PivotTableSourceExportResponse[source]¶

type Global___PivotTableViewExpansionsMessage = PivotTableViewExpansionsMessage[source]¶

type Global___PivotTableViewRequest = PivotTableViewRequest[source]¶

type Global___PivotTableViewResponse = PivotTableViewResponse[source]¶