BigtableSource

データをインポートする Cloud Bigtable ソース。

JSON 表現
{
  "projectId": string,
  "instanceId": string,
  "tableId": string,
  "bigtableOptions": {
    object (BigtableOptions)
  }
}
フィールド
projectId

string

Bigtable ソースを含むプロジェクトのプロジェクト ID。長さの上限は 128 文字です。指定しない場合、親リクエストからプロジェクト ID を継承します。

instanceId

string

必須。インポートする必要がある Cloud Bigtable のインスタンス ID。

tableId

string

必須。インポートする必要がある Cloud Bigtable のテーブル ID。

bigtableOptions

object (BigtableOptions)

必須。データを型付き構造に解析するときに必要な情報を含む Bigtable オプション。たとえば、列の型のアノテーションなどです。

BigtableOptions

インポートをサポートする情報を含む Bigtable オプション オブジェクト。

JSON 表現
{
  "keyFieldName": string,
  "families": {
    string: {
      object (BigtableColumnFamily)
    },
    ...
  }
}
フィールド
keyFieldName

string

ドキュメントに行キー値を保存するために使用されるフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。

families

map (key: string, value: object (BigtableColumnFamily))

ファミリー名から、指定された列ファミリーの列ファミリー レベルの情報を含むオブジェクトへのマッピング。このマップにないファミリは無視されます。

BigtableColumnFamily

Bigtable の列ファミリー。

JSON 表現
{
  "fieldName": string,
  "encoding": enum (Encoding),
  "type": enum (Type),
  "columns": [
    {
      object (BigtableColumn)
    }
  ]
}
フィールド
fieldName

string

ドキュメントでこの列ファミリーに使用するフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。設定されていない場合は、ファミリー名から解析されます。ただし、命名パターンが異なるため、フィールド名の競合が発生する可能性があります。この場合、解析動作は未定義です。

encoding

enum (Encoding)

型が STRING でない場合の値のエンコード モード。使用できるエンコード値は次のとおりです。

  • TEXT: 値が英数字のテキスト文字列であることを示します。
  • BINARY: 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。これは、columns に列を一覧表示して、エンコードを指定することによって、特定の列に対してオーバーライドできます。
type

enum (Type)

この列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。

columns[]

object (BigtableColumn)

各列の列レベルの情報を含むオブジェクトのリスト。このリストに含まれていない列は無視されます。

エンコード

Bigtable の列または列ファミリーのエンコード モード。

列挙型
ENCODING_UNSPECIFIED エンコードは指定されていません。
TEXT テキスト エンコード。
BINARY バイナリ エンコード。

タイプ

Bigtable の列または列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。

列挙型
TYPE_UNSPECIFIED タイプが指定されていません。
STRING 文字列型。
NUMBER 数値型。
INTEGER 整数型。
VAR_INTEGER 可変長の整数型。
BIG_NUMERIC BigDecimal 型。
BOOLEAN ブール型。
JSON JSON 型。

BigtableColumn

Bigtable の列。

JSON 表現
{
  "qualifier": string,
  "fieldName": string,
  "encoding": enum (Encoding),
  "type": enum (Type)
}
フィールド
qualifier

string (bytes format)

必須。列の修飾子。utf-8 でデコードできない場合は、代わりに base-64 でエンコードされた文字列を使用します。

Base64 でエンコードされた文字列。

fieldName

string

ドキュメントでこの列に使用するフィールド名。名前はパターン [a-zA-Z0-9][a-zA-Z0-9-_]* と一致する必要があります。設定されていない場合は、修飾子バイトから最善を尽くして解析されます。ただし、命名パターンが異なるため、フィールド名の競合が発生する可能性があります。この場合、解析動作は未定義です。

encoding

enum (Encoding)

型が STRING でない場合の値のエンコード モード。使用できるエンコード値は次のとおりです。

  • TEXT: 値が英数字のテキスト文字列であることを示します。
  • BINARY: 値が HBase Bytes.toBytes ファミリーの関数を使用してエンコードされていることを示します。これは、columns に列を一覧表示して、エンコードを指定することによって、特定の列に対してオーバーライドできます。
type

enum (Type)

この列ファミリーの値の型。エンコード値が BINARY に設定されている場合、値は HBase Bytes.toBytes 関数を使用してエンコードされることが想定されます。