Google Cloudでリソースを更新する場合、リソース全体を置き換えることなく、特定のフィールドを変更することがよくあります。Rust 用の Cloud クライアント ライブラリはフィールド マスクをサポートしているため、更新オペレーションで変更するフィールドを指定し、他のすべてのフィールドを変更しないままにできます。
始める前に
このドキュメントでは Secret Manager API を使用しますが、他の Google Cloud サービスにも同じコンセプトが適用されます。
このドキュメントのコードを実行する前に、次の前提条件を満たしてください。
- Rust を使ってみるの手順に沿って、開発環境をセットアップします。
- Secret Manager を使用してシークレットを作成してアクセスするの手順に沿って、Secret Manager API を有効にして認証を構成します。
依存関係
google-cloud-wkt クレートは、FieldMask を含む Google CloudAPI のよく知られた型を提供します。google-cloud-secretmanager-v1、google-cloud-wkt、anyhow、tokio を Cargo.toml ファイルに追加します。
cargo add google-cloud-secretmanager-v1 google-cloud-wkt anyhow
cargo add tokio --features macros,rt-multi-thread
フィールド マスクの仕組み
FieldMask には、更新オペレーションで変更するフィールドや読み取りオペレーションで返すフィールドを識別する一連のシンボリック フィールドパスが含まれています。
更新オペレーションでは、サービスはマスクにリストされているフィールドのみを変更し、リクエスト メッセージ内のリストにないフィールドの値は無視します。更新リクエストでフィールド マスクを省略すると、オペレーションはすべての変更可能なフィールドに適用されます。
特定のフィールドをデフォルト値にリセットするには、マスクにフィールドパスを含め、リソース構造体でそのフィールドをデフォルト値のままにします。
リソースのフィールドを更新する
シークレットを作成し、FieldMask を使用して labels フィールドと annotations フィールドを選択的に更新するには、次の手順を完了します。
SecretManagerServiceクライアントを初期化し、空のlabelsとannotationsを含むシークレットを作成します。labels、annotations、現在のetag(同時更新の上書きを防ぐため)、"annotations"と"labels"をカバーする更新マスクを設定するupdate_secretリクエストを送信します。set_update_mask呼び出しでは、変更する正確なフィールドパスを指定します。
出力で、オペレーションによって両方のフィールドが更新されたことを確認できます。
labels: {"updated": "your-label"},
...
annotations: {"updated": "your-annotations"},
コードを補完する
次の関数は、シークレットの作成とフィールド マスクの更新を組み合わせたものです。
クリーンアップ
Google Cloud アカウントに課金されないようにし、後続の実行で ALREADY_EXISTS エラーが発生しないようにするには、完了後に your-secret シークレットを削除します。