Menggunakan label resource

Halaman ini menunjukkan cara menambahkan, melihat, mengedit, dan menghapus label pada resource Cloud Healthcare API. Label adalah pasangan nilai kunci yang dapat Anda gunakan untuk mengatur resource. Anda dapat melampirkan label ke tiap resource, lalu memfilter resource berdasarkan labelnya. Informasi tentang label diteruskan ke sistem penagihan, sehingga Anda dapat memperinci biaya penagihan berdasarkan label.

Anda dapat menggunakan label dengan resource Cloud Healthcare API berikut:

  • Toko FHIR
  • Penyimpanan DICOM
  • Penyimpanan izin
  • Toko HL7v2
  • Pesan HL7v2

Label tersedia menggunakan REST API atau RPC API. Label tidak tersedia di Google Cloud CLI atau Konsol Google Cloud.

Persyaratan label

Label yang diterapkan ke resource harus memenuhi persyaratan berikut:

  • Setiap resource dapat memiliki beberapa label, hingga maksimum 64.
  • Setiap label harus berupa pasangan nilai kunci.
  • Kunci memiliki panjang minimum 1 karakter dan panjang maksimum 63 karakter, serta tidak boleh kosong. Nilai boleh kosong dan memiliki panjang maksimum 63 karakter.
  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda pisah. Semua karakter harus menggunakan encoding UTF-8 dan karakter internasional diperbolehkan.
  • Kunci label harus unik dalam satu resource, tetapi Anda dapat menggunakan kunci yang sama dengan beberapa resource.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.

Menambahkan label

Contoh berikut menunjukkan cara menambahkan label ke penyimpanan FHIR yang ada.

Misalnya, Anda dapat menggunakan label ini untuk menunjukkan bahwa penyimpanan FHIR sedang digunakan sebagai lingkungan pengujian. Kunci untuk label ini adalah environment dan nilainya adalah test.

curl

Untuk menambahkan label ke penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH yang menggunakan curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY' : 'VALUE'
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

PowerShell

Untuk menambahkan label ke penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH menggunakan Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY': 'VALUE'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY": "VALUE"
  }
}

Menambahkan beberapa label

Contoh berikut menunjukkan cara menambahkan beberapa label ke penyimpanan FHIR yang ada. Untuk menambahkan beberapa label, pisahkan setiap label dengan koma.

Misalnya, Anda dapat menggunakan label untuk menunjukkan bahwa penyimpanan FHIR sedang digunakan sebagai lingkungan pengujian dan digunakan untuk tim peneliti.

Kunci untuk label pertama adalah environment dan nilainya adalah test. Kunci untuk label kedua adalah team dan nilainya akan menjadi research.

curl

Untuk menambahkan beberapa label ke penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui sebagai daftar key-value pair yang dipisahkan koma
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH yang menggunakan curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY_1' : 'VALUE_1',
        'KEY_2' : 'VALUE_2'
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY_1": "VALUE_1",
    "KEY_2": "VALUE_2"
  }
}

PowerShell

Untuk menambahkan label ke penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui sebagai daftar key-value pair yang dipisahkan koma
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH menggunakan Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Patch `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY_1': 'VALUE_1',
        'KEY_2': 'VALUE_2'
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY_1": "VALUE_1",
    "KEY_2": "VALUE_2"
  }
}

Mencantumkan dan memfilter berdasarkan label

Setelah menambahkan label ke resource Cloud Healthcare API, Anda dapat mencantumkan resource dan memfilternya menurut labelnya. Misalnya, setelah menambahkan label ke penyimpanan FHIR di sampel sebelumnya, Anda dapat mencantumkan penyimpanan FHIR di set data Anda dan memfilter menurut label yang ditambahkan.

Pesan HL7v2 memiliki opsi pemfilteran tambahan yang dapat Anda lihat di projects.locations.datasets.hl7V2Stores.messages.list.

curl

Untuk melihat penyimpanan FHIR dalam set data dan memfilternya menurut label, buat permintaan GET dan berikan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • String kueri yang berisi informasi yang akan difilter
  • Token akses

Contoh berikut menunjukkan permintaan GET yang menggunakan curl.

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores?filter=labels.KEY=VALUE"

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "fhirStores": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "labels": {
        "KEY": "VALUE"
      }
    },
    {
      ...
    }
  ]
}

PowerShell

Untuk melihat penyimpanan FHIR dalam set data dan memfilternya menurut label, buat permintaan GET dan berikan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • String kueri yang berisi informasi yang akan difilter
  • Token akses

Contoh berikut menunjukkan permintaan GET menggunakan Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Get `
  -Headers $headers `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores?filter=labels.KEY=VALUE" | Select-Object -Expand Content

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "fhirStores": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
      "labels": {
        "KEY": "VALUE"
      }
    },
    {
      ...
    }
  ]
}

Menghapus label

Anda dapat menghapus label dengan salah satu dari dua cara berikut:

  • Untuk menghapus label sepenuhnya, yang berarti kunci dan nilai dihapus, gunakan pola baca-modifikasi-tulis dengan menyelesaikan langkah berikut:

    1. Baca label saat ini dengan memanggil metode get() resource.
    2. Edit label yang ditampilkan, baik menggunakan editor teks maupun secara terprogram, untuk menambahkan atau menghapus kunci yang berlaku beserta nilainya.
    3. Tulis label yang telah diperbarui dengan memanggil metode patch() resource.

  • Untuk mempertahankan kunci dan menghapus nilai, setel nilai ke null.

curl

Contoh berikut menunjukkan cara menghapus label dengan menyetel nilai label ke null.

Untuk menghapus label dari penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH yang menggunakan curl.

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    --data "{
      'labels': {
        'KEY' : null
      }
     }" "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels"

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY":
  }
}

PowerShell

Contoh berikut menunjukkan cara menghapus label dengan menyetel nilai label ke null.

Untuk menghapus label dari penyimpanan FHIR yang ada, buat permintaan PATCH dan tentukan informasi berikut:

  • Nama set data induk
  • Nama toko FHIR
  • Data label yang akan diperbarui
  • Mask pembaruan ditetapkan ke labels
  • Token akses

Contoh berikut menunjukkan permintaan PATCH menggunakan Windows PowerShell.

$cred = gcloud auth application-default print-access-token
$headers = @{ Authorization = "Bearer $cred" }

Invoke-WebRequest `
  -Method Post `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -Body "{
      'labels': {
        'KEY': nullresource_manager_api
      }
  }" `
  -Uri "https://healthcare.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID?updateMask=labels" | Select-Object -Expand Content

Jika permintaan berhasil, server akan menampilkan respons dalam format JSON:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/datasets/DATASET_ID/fhirStores/FHIR_STORE_ID",
  "labels": {
    "KEY":
  }
}

Langkah selanjutnya

Baca tentang kegunaan label dengan Cloud Resource Manager API.