DataFlex

Manage Cloud Storage Bucket Labels

See more Google Cloud Storage Examples

Demonstrates how to add, update, and delete labels for a Cloud Storage bucket. DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoSbToken
    Variant vJson
    Handle hoJson
    Handle hoHttp
    String sUrl
    Variant vResp
    Handle hoResp
    Integer iResponseCode
    String sTemp1

    Move False To iSuccess

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // This example uses a previously obtained access token having permission for the 
    // scope "https://www.googleapis.com/auth/cloud-platform"

    // In this example, Get Google Cloud Storage OAuth2 Access Token, 
    // the service account access token was saved to a text file.  This example fetches the access token from the file..
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbToken
    If (Not(IsComObjectCreated(hoSbToken))) Begin
        Send CreateComObject of hoSbToken
    End
    Get ComLoadFile Of hoSbToken "qa_data/tokens/googleCloudStorageAccessToken.txt" "utf-8" To iSuccess

    // ---- Step 1
    // Create the JSON body of the PATCH request that will be sent.
    // This specifies labels to be added, updated, and/or deleted.
    // (To delete a label, set its value equal to null.)

    // {
    //   "labels": {
    //     "new_label_key": "new_label_value",
    //     "existing_label_key": "updated_label_value",
    //     "old_label_key": null
    //   }
    // }

    // ---------
    // Important
    // ---------
    // You can apply multiple labels to each bucket, with a maximum of 64 labels per bucket.

    //     - Keys and values cannot be longer than 63 characters each.
    //     - Keys and values can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed.
    //     - Label keys must start with a lowercase letter and international characters are allowed.
    //     - Label keys cannot be empty.

    // Build JSON to update labels.
    // 
    // During the testing of this example, my bucket already has the following labels:
    // {
    //  "labels": {
    //   "test1": "xyz",
    //   "test": "abc",
    //   "a": "abc"
    //  }
    // }

    // For this example, I'm going to add a label "b", delete the label "test1", and update
    // the label "test".
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "labels.b" "bbb" To iSuccess
    Get ComUpdateString Of hoJson "labels.test" "abc123" To iSuccess
    Get ComUpdateNull Of hoJson "labels.test1" To iSuccess

    // ---- Step 2
    // Send a PATCH equivalent to this curl command

    // curl -X PATCH --data-binary @[JSON_FILE_NAME].json \
    //     -H "Authorization: Bearer [OAUTH2_TOKEN]" \
    //     -H "Content-Type: application/json" \
    //     "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=labels"

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End
    Get ComGetAsString Of hoSbToken To sTemp1
    Set ComAuthToken Of hoHttp To sTemp1

    Get ComSetUrlVar Of hoHttp "bucket_name" "chilkat-ocean" To iSuccess
    Move "https://www.googleapis.com/storage/v1/b/{$bucket_name}?fields=labels" To sUrl
    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "PATCH" sUrl vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iResponseCode
    If (iResponseCode = 401) Begin
        Get ComBodyStr Of hoResp To sTemp1
        Showln sTemp1
        Showln "If invalid credentials, then it is likely the access token expired."
        Showln "Your app should automatically fetch a new access token and re-try."
        Procedure_Return
    End

    // Note: A 400 response code is likely caused by illegal characters used for a label name and/or value.

    Showln "Response code: " iResponseCode
    Showln "Response body"
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1

    // A response code = 200 indicates success, and the response body contains the JSON
    // for the new/updated set of labels
    // Response code: 200
    // Response body
    // {
    //  "labels": {
    //   "test": "abc123",
    //   "a": "abc",
    //   "b": "bbb"
    //  }
    // }


End_Procedure