input_data update#

Description#

入力データの名前または入力データのパスを更新します。

Examples#

CSVファイルを指定する場合#

--csv に、更新対象の入力データ情報が記載されたCSVファイルのパスを指定してください。

CSVのフォーマットは以下の通りです。

  • カンマ区切り

  • ヘッダ行あり

列名

必須

備考

input_data_id

Yes

更新対象の入力データID

input_data_name

No

変更後の入力データ名。更新しない場合は空欄

input_data_path

No

変更後の入力データパス。更新しない場合は空欄。先頭が file:// の場合、ローカルのファイルを入力データに使用します。

以下はCSVファイルのサンプルです。

input_data.csv#
input_data_id,input_data_name,input_data_path
id1,new_name1,
id2,,s3://bucket/new_image.jpg
id3,new_name3,https://example.com/new_image.jpg
id4,,file://new_image.jpg

警告

プライベートストレージが利用可能な組織配下のプロジェクトでしか、 input_data_path に https または s3 スキームを利用できません。 プライベートストレージを利用するには、Annofabサポート窓口への問い合わせが必要です。 詳細は https://annofab.readme.io/docs/external-storage を参照してください。

input_data_path の先頭が file:// の場合、指定したローカルファイルをアップロードし、入力データのパスをアップロード後のパスに更新します。

$ annofabcli input_data update --project_id prj1 --csv input_data.csv

JSON文字列を指定する場合#

--json に、更新対象の入力データ情報をJSON文字列で指定してください。

以下は、JSONのサンプルです。

input_data.json#
[
    {
        "input_data_id": "id1",
        "input_data_name": "new_name1"
    },
    {
        "input_data_id": "id2",
        "input_data_path": "s3://bucket/new_image.jpg"
    },
    {
        "input_data_id": "id3",
        "input_data_name": "new_name3",
        "input_data_path": "https://example.com/new_image.jpg"
    },
    {
        "input_data_id": "id4",
        "input_data_path": "file://new_image.jpg"
    }
]

JSONのキーは、 --csv に指定するCSVファイルの列に対応します。 更新しないプロパティは、キーを記載しないか値をnullにしてください。

--json にJSON形式の文字列、またはJSONファイルのパスを指定できます。

$ annofabcli input_data update --project_id prj1 --json file://input_data.json

Usage Details#

入力データの名前または入力データのパスを更新します。

usage: annofabcli input_data update [-h] [--yes] [--endpoint_url ENDPOINT_URL]
                                    [--annofab_user_id ANNOFAB_USER_ID]
                                    [--annofab_password ANNOFAB_PASSWORD]
                                    [--annofab_pat ANNOFAB_PAT]
                                    [--logdir LOGDIR] [--disable_log]
                                    [--debug] -p PROJECT_ID
                                    (--csv CSV | --json JSON)
                                    [--parallelism {2,3,4}]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。

--csv

更新対象の入力データと更新後の値が記載されたCSVファイルのパスを指定します。 CSVのフォーマットは以下の通りです。

  • ヘッダ行あり, カンマ区切り

  • input_data_id (required)

  • input_data_name (optional)

  • input_data_path (optional): file:// を先頭に付けると、ローカルファイルを入力データに使用します。

更新しないプロパティは、セルの値を空欄にしてください。

--json

更新対象の入力データと更新後の値をJSON形式で指定します。 JSONの各キーは --csv に渡すCSVの各列に対応しています。 file:// を先頭に付けるとjsonファイルを指定できます。 (ex) [{"input_data_id":"id1","input_data_name":"new_name1"},{"input_data_id":"id2","input_data_path":"file://new_image.jpg"}] 更新しないプロパティは、キーを記載しないか値をnullにしてください。

--parallelism

Possible choices: 2, 3, 4

使用するプロセス数（並列度）。指定しない場合は、逐次的に処理します。指定する場合は --yes も一緒に指定する必要があります。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

オーナロールを持つユーザで実行してください。