As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Area120 Tables v1alpha1 API

class google.area120.tables_v1alpha1.types.BatchCreateRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.BatchCreateRows.

parent

Required. The parent table where the rows will be created. Format: tables/{table}

Type

str

requests

Required. The request message specifying the rows to create. A maximum of 500 rows can be created in a single batch.

Type

MutableSequence[google.area120.tables_v1alpha1.types.CreateRowRequest]

class google.area120.tables_v1alpha1.types.BatchCreateRowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for TablesService.BatchCreateRows.

rows

The created rows.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Row]

class google.area120.tables_v1alpha1.types.BatchDeleteRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.BatchDeleteRows

parent

Required. The parent table shared by all rows being deleted. Format: tables/{table}

Type

str

names

Required. The names of the rows to delete. All rows must belong to the parent table or else the entire batch will fail. A maximum of 500 rows can be deleted in a batch. Format: tables/{table}/rows/{row}

Type

MutableSequence[str]

class google.area120.tables_v1alpha1.types.BatchUpdateRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.BatchUpdateRows.

parent

Required. The parent table shared by all rows being updated. Format: tables/{table}

Type

str

requests

Required. The request messages specifying the rows to update. A maximum of 500 rows can be modified in a single batch.

Type

MutableSequence[google.area120.tables_v1alpha1.types.UpdateRowRequest]

class google.area120.tables_v1alpha1.types.BatchUpdateRowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for TablesService.BatchUpdateRows.

rows

The updated rows.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Row]

class google.area120.tables_v1alpha1.types.ColumnDescription(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Details on a column in the table.

name

column name

Type

str

data_type

Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.

Type

str

id

Internal id for a column.

Type

str

labels

Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.

Type

MutableSequence[google.area120.tables_v1alpha1.types.LabeledItem]

relationship_details

Optional. Additional details about a relationship column. Specified when data_type is relationship.

Type

google.area120.tables_v1alpha1.types.RelationshipDetails

lookup_details

Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column.

Type

google.area120.tables_v1alpha1.types.LookupDetails

class google.area120.tables_v1alpha1.types.CreateRowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.CreateRow.

parent

Required. The parent table where this row will be created. Format: tables/{table}

Type

str

row

Required. The row to create.

Type

google.area120.tables_v1alpha1.types.Row

view

Optional. Column key to use for values in the row. Defaults to user entered name.

Type

google.area120.tables_v1alpha1.types.View

class google.area120.tables_v1alpha1.types.DeleteRowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.DeleteRow

name

Required. The name of the row to delete. Format: tables/{table}/rows/{row}

Type

str

class google.area120.tables_v1alpha1.types.GetRowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.GetRow.

name

Required. The name of the row to retrieve. Format: tables/{table}/rows/{row}

Type

str

view

Optional. Column key to use for values in the row. Defaults to user entered name.

Type

google.area120.tables_v1alpha1.types.View

class google.area120.tables_v1alpha1.types.GetTableRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.GetTable.

name

Required. The name of the table to retrieve. Format: tables/{table}

Type

str

class google.area120.tables_v1alpha1.types.GetWorkspaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.GetWorkspace.

name

Required. The name of the workspace to retrieve. Format: workspaces/{workspace}

Type

str

class google.area120.tables_v1alpha1.types.LabeledItem(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A single item in a labeled column.

name

Display string as entered by user.

Type

str

id

Internal id associated with the item.

Type

str

class google.area120.tables_v1alpha1.types.ListRowsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.ListRows.

parent

Required. The parent table. Format: tables/{table}

Type

str

page_size

The maximum number of rows to return. The service may return fewer than this value.

If unspecified, at most 50 rows are returned. The maximum value is 1,000; values above 1,000 are coerced to 1,000.

Type

int

page_token

A page token, received from a previous ListRows call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRows must match the call that provided the page token.

Type

str

view

Optional. Column key to use for values in the row. Defaults to user entered name.

Type

google.area120.tables_v1alpha1.types.View

filter

Optional. Raw text query to search for in rows of the table. Special characters must be escaped. Logical operators and field specific filtering not supported.

Type

str

class google.area120.tables_v1alpha1.types.ListRowsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for TablesService.ListRows.

rows

The rows from the specified table.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Row]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

Type

str

class google.area120.tables_v1alpha1.types.ListTablesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.ListTables.

page_size

The maximum number of tables to return. The service may return fewer than this value.

If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.

Type

int

page_token

A page token, received from a previous ListTables call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTables must match the call that provided the page token.

Type

str

class google.area120.tables_v1alpha1.types.ListTablesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for TablesService.ListTables.

tables

The list of tables.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Table]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

Type

str

class google.area120.tables_v1alpha1.types.ListWorkspacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.ListWorkspaces.

page_size

The maximum number of workspaces to return. The service may return fewer than this value.

If unspecified, at most 10 workspaces are returned. The maximum value is 25; values above 25 are coerced to 25.

Type

int

page_token

A page token, received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

Type

str

class google.area120.tables_v1alpha1.types.ListWorkspacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for TablesService.ListWorkspaces.

workspaces

The list of workspaces.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Workspace]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

Type

str

class google.area120.tables_v1alpha1.types.LookupDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Details about a lookup column whose value comes from the associated relationship.

relationship_column

The name of the relationship column associated with the lookup.

Type

str

relationship_column_id

The id of the relationship column.

Type

str

class google.area120.tables_v1alpha1.types.RelationshipDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Details about a relationship column.

linked_table

The name of the table this relationship is linked to.

Type

str

class google.area120.tables_v1alpha1.types.Row(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A single row in a table.

name

The resource name of the row. Row names have the form tables/{table}/rows/{row}. The name is ignored when creating a row.

Type

str

values

The values of the row. This is a map of column key to value. Key is user entered name(default) or the internal column id based on the view in the request.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

class ValuesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.area120.tables_v1alpha1.types.Table(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A single table.

name

The resource name of the table. Table names have the form tables/{table}.

Type

str

display_name

The human readable title of the table.

Type

str

columns

List of columns in this table. Order of columns matches the display order.

Type

MutableSequence[google.area120.tables_v1alpha1.types.ColumnDescription]

class google.area120.tables_v1alpha1.types.UpdateRowRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for TablesService.UpdateRow.

row

Required. The row to update.

Type

google.area120.tables_v1alpha1.types.Row

update_mask

The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

view

Optional. Column key to use for values in the row. Defaults to user entered name.

Type

google.area120.tables_v1alpha1.types.View

class google.area120.tables_v1alpha1.types.View(value)

Bases: proto.enums.Enum

Column identifier used for the values in the row.

Values:

VIEW_UNSPECIFIED (0):

Defaults to user entered text.

COLUMN_ID_VIEW (1):

Uses internally generated column id to identify values.

class google.area120.tables_v1alpha1.types.Workspace(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A single workspace.

name

The resource name of the workspace. Workspace names have the form workspaces/{workspace}.

Type

str

display_name

The human readable title of the workspace.

Type

str

tables

The list of tables in the workspace.

Type

MutableSequence[google.area120.tables_v1alpha1.types.Table]