Skip to content
This repository was archived by the owner on Mar 26, 2026. It is now read-only.
This repository was archived by the owner on Mar 26, 2026. It is now read-only.

Documentation for enums is missing #1567

@parthea

Description

@parthea

See the enum for PartitionKey in the golden file below.

class PartitionKey(proto.Enum):
r"""This enum is used to determine the partition key column when
exporting assets to BigQuery partitioned table(s). Note that, if the
partition key is a timestamp column, the actual partition is based
on its date value (expressed in UTC. see details in
https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables).
"""
PARTITION_KEY_UNSPECIFIED = 0
READ_TIME = 1
REQUEST_TIME = 2

The documentation for enums PARTITION_KEY_UNSPECIFIED, READ_TIME and REQUEST_TIME appear in the proto file but not in the generated code.

  enum PartitionKey {
    // Unspecified partition key. If used, it means using non-partitioned table.
    PARTITION_KEY_UNSPECIFIED = 0;

    // The time when the snapshot is taken. If specified as partition key, the
    // result table(s) is partitoned by the additional timestamp column,
    // readTime. If [read_time] in ExportAssetsRequest is specified, the
    // readTime column's value will be the same as it. Otherwise, its value will
    // be the current time that is used to take the snapshot.
    READ_TIME = 1;

    // The time when the request is received and started to be processed. If
    // specified as partition key, the result table(s) is partitoned by the
    // requestTime column, an additional timestamp column representing when the
    // request was received.
    REQUEST_TIME = 2;
  }

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions