Memperbarui resource menggunakan mask kolom

Saat memperbarui resource di Google Cloud, Anda sering kali ingin mengubah kolom tertentu tanpa mengganti seluruh resource. Library Klien Cloud untuk Rust mendukung masker kolom sehingga Anda dapat menentukan kolom mana yang diubah oleh operasi update dan membiarkan semua kolom lainnya tidak berubah.

Sebelum memulai

Dokumen ini menggunakan Secret Manager API, meskipun konsep yang sama berlaku untuk layanan Google Cloud lainnya.

Sebelum menjalankan kode dalam dokumen ini, selesaikan prasyarat berikut:

Dependensi

Crate google-cloud-wkt menyediakan jenis yang dikenal untuk API Google Cloud, termasuk FieldMask. Tambahkan google-cloud-secretmanager-v1, google-cloud-wkt, anyhow, dan tokio ke file Cargo.toml Anda:

cargo add google-cloud-secretmanager-v1 google-cloud-wkt anyhow
cargo add tokio --features macros,rt-multi-thread

Cara kerja mask kolom

FieldMask berisi kumpulan jalur kolom simbolis yang mengidentifikasi kolom mana yang diubah oleh operasi update atau ditampilkan oleh operasi baca.

Dalam operasi update, layanan hanya mengubah kolom yang tercantum dalam mask dan mengabaikan nilai pada kolom yang tidak tercantum dalam pesan permintaan. Jika Anda menghilangkan mask kolom pada permintaan update, operasi akan berlaku untuk semua kolom yang dapat diubah.

Untuk mereset kolom tertentu ke nilai defaultnya, sertakan jalur kolom di masker dan biarkan kolom tersebut pada nilai defaultnya di struct resource.

Memperbarui kolom pada resource

Untuk membuat secret dan memperbarui kolom labels dan annotations secara selektif menggunakan FieldMask, selesaikan langkah-langkah berikut:

  1. Lakukan inisialisasi klien SecretManagerService dan buat secret dengan labels dan annotations kosong:

    let client = SecretManagerService::builder().build().await?;
    
    let secret = client
        .create_secret()
        .set_parent(format!("projects/{project_id}"))
        .set_secret_id("your-secret")
        .set_secret(
            Secret::new().set_replication(Replication::new().set_automatic(Automatic::new())),
        )
        .send()
        .await?;
    println!("CREATE = {secret:?}");

  2. Kirim permintaan update_secret yang menetapkan labels, annotations, etag saat ini untuk mencegah penimpaan update serentak, dan mask update yang mencakup "annotations" dan "labels":

    let tag = |mut labels: HashMap<_, _>, msg: &str| {
        labels.insert("updated".to_string(), msg.to_string());
        labels
    };
    
    let update = client
        .update_secret()
        .set_secret(
            Secret::new()
                .set_name(&secret.name)
                .set_etag(secret.etag)
                .set_labels(tag(secret.labels, "your-label"))
                .set_annotations(tag(secret.annotations, "your-annotations")),
        )
        .set_update_mask(FieldMask::default().set_paths(["annotations", "labels"]))
        .send()
        .await?;
    println!("UPDATE = {update:?}");

    Panggilan set_update_mask menentukan jalur kolom yang tepat untuk diubah:

    .set_update_mask(FieldMask::default().set_paths(["annotations", "labels"]))

Output mengonfirmasi bahwa operasi memperbarui kedua kolom:

labels: {"updated": "your-label"},
...
annotations: {"updated": "your-annotations"},

Kode lengkap

Fungsi berikut menggabungkan pembuatan secret dan update field-mask:

use google_cloud_secretmanager_v1::client::SecretManagerService;
use google_cloud_secretmanager_v1::model::replication::Automatic;
use google_cloud_secretmanager_v1::model::{Replication, Secret};
use google_cloud_wkt::FieldMask;
use std::collections::HashMap;

pub async fn sample(project_id: &str) -> anyhow::Result<()> {
    let client = SecretManagerService::builder().build().await?;

    let secret = client
        .create_secret()
        .set_parent(format!("projects/{project_id}"))
        .set_secret_id("your-secret")
        .set_secret(
            Secret::new().set_replication(Replication::new().set_automatic(Automatic::new())),
        )
        .send()
        .await?;
    println!("CREATE = {secret:?}");

    let tag = |mut labels: HashMap<_, _>, msg: &str| {
        labels.insert("updated".to_string(), msg.to_string());
        labels
    };

    let update = client
        .update_secret()
        .set_secret(
            Secret::new()
                .set_name(&secret.name)
                .set_etag(secret.etag)
                .set_labels(tag(secret.labels, "your-label"))
                .set_annotations(tag(secret.annotations, "your-annotations")),
        )
        .set_update_mask(FieldMask::default().set_paths(["annotations", "labels"]))
        .send()
        .await?;
    println!("UPDATE = {update:?}");

    Ok(())
}

Pembersihan

Agar akun Google Cloud Anda tidak dikenai biaya dan untuk mencegah error ALREADY_EXISTS pada operasi berikutnya, hapus secret your-secret setelah Anda selesai.