REST Resource: projects.locations.instances.dataTables

Resource: DataTable

DataTable represents the data table resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "columnInfo": [
    {
      object (DataTableColumnInfo)
    }
  ],
  "dataTableUuid": string,
  "rules": [
    string
  ],
  "ruleAssociationsCount": integer,
  "rowTimeToLive": string,
  "approximateRowCount": string,
  "scopeInfo": {
    object (DataTableScopeInfo)
  },
  "updateSource": enum (DataTableUpdateSource)
}
Fields
name

string

Identifier. The resource name of the data table Format: "{project}/locations/{region}/instances/{instance}/dataTables/{dataTable}"
displayName

string

Output only. The unique display name of the data table.
description

string

Required. A user-provided description of the data table.
createTime

string (Timestamp format)

Output only. Table create time

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Table update time

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
columnInfo[]

object (DataTableColumnInfo)

Immutable. Details of all the columns in the table
dataTableUuid

string

Output only. Data table unique id
rules[]

string

Output only. The resource names for the associated Rules that use this data table. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}. {rule} here refers to the rule id.
ruleAssociationsCount

integer

Output only. The count of rules using the data table.
rowTimeToLive

string

Optional. User-provided TTL of the data table.
approximateRowCount

string (int64 format)

Output only. The count of rows in the data table.
scopeInfo

object (DataTableScopeInfo)

Optional. The scope info of the data table. During data table creation, if this field is not set, the data table without scopes (an unscoped table) will be created for a global user. For a scoped user, this field must be set. During data table update, if scopeInfo is requested to be updated, this field must be set.
updateSource

enum (DataTableUpdateSource)

Output only. Source of the data table update.

DataTableColumnInfo

DataTableColumnInfo represents the column metadata of the datatable. The columnIndex represents the ordering of the values in DataTableRow. NEXT TAG: 7

JSON representation 
{
  "columnIndex": integer,
  "originalColumn": string,
  "keyColumn": boolean,
  "repeatedValues": boolean,

  // Union field path_or_type can be only one of the following:
  "mappedColumnPath": string,
  "columnType": enum (DataTableColumnType)
  // End of list of possible types for union field path_or_type.
}
Fields
columnIndex

integer

Required. Column Index. 0,1,2...
originalColumn

string

Required. Original column name of the Data Table (present in the CSV header in case of creation of data tables using file uploads). It must satisfy the following requirements: - Starts with letter. - Contains only letters, numbers and underscore. - Must be unique and has length < 256.
keyColumn

boolean

Optional. Whether to include this column in the calculation of the row ID. If no columns have keyColumn = true, all columns will be included in the calculation of the row ID.
repeatedValues

boolean

Optional. Whether the column is a repeated values column.

Union field path_or_type.

path_or_type can be only one of the following:
mappedColumnPath

string

Entity proto field path that the column is mapped to
columnType

enum (DataTableColumnType)

Column type can be STRING, CIDR (Ex- 10.1.1.0/24), REGEX

DataTableColumnType

DataTableColumnType denotes the type of the column to be referenced in the rule. NEXT TAG: 5

Enums
DATA_TABLE_COLUMN_TYPE_UNSPECIFIED The default Data Table Column Type.
STRING Denotes the type of the column as STRING.
REGEX Denotes the type of the column as REGEX.
CIDR Denotes the type of the column as CIDR.
NUMBER Denotes the type of the column as NUMBER (includes int and float).

DataTableScopeInfo

DataTableScopeInfo specifies the scope info of the data table.

JSON representation 
{
  "dataAccessScopes": [
    string
  ]
}
Fields
dataAccessScopes[]

string

Required. Contains the list of scope names of the data table. If the list is empty, the data table is treated as unscoped. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scopeName}"

DataTableUpdateSource

DataTableUpdateSource denotes the source that updated the data table. NEXT TAG: 4

Enums
DATA_TABLE_UPDATE_SOURCE_UNSPECIFIED The data table is updated by the user.
USER The data table is updated by the user.
RULE The data table is updated by the rule.
SEARCH The data table is updated by the search.

Methods

create

 Create a new data table.

delete

 Delete data table.

get

 Get data table info.

list

 List data tables.

patch

 Update data table.

upload

 Create data table from a bulk file.