PureBasic

Manage Bucket Storage Class

See more Google Cloud Storage Examples

Demonstrates how to manage a bucket's default storage class.

See Cloud Storage Classes for information about storage classes.

PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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..
    sbToken.i = CkStringBuilder::ckCreate()
    If sbToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckLoadFile(sbToken,"qa_data/tokens/googleCloudStorageAccessToken.txt","utf-8")

    ; ---- Step 1
    ; Create the JSON body of the PUT request that will be sent.

    ; {
    ;   "storageClass": "[STORAGE_CLASS]"
    ; }
    ; 

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Be careful if using the "regional" storage class.  See the note below about the 400 error response.
    CkJsonObject::ckUpdateString(json,"storageClass","nearline")

    ; ---- Step 2
    ; Send a PUT equivalent to this curl command

    ; curl -X PUT --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=storageClass"

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttp::setCkAuthToken(http, CkStringBuilder::ckGetAsString(sbToken))

    CkHttp::ckSetUrlVar(http,"bucket_name","chilkat-ocean")
    url.s = "https://www.googleapis.com/storage/v1/b/{$bucket_name}?fields=storageClass"
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"PUT",url,json,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkStringBuilder::ckDispose(sbToken)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    responseCode.i = CkHttpResponse::ckStatusCode(resp)
    If responseCode = 401
        Debug CkHttpResponse::ckBodyStr(resp)
        Debug "If invalid credentials, then it is likely the access token expired."
        Debug "Your app should automatically fetch a new access token and re-try."
        CkStringBuilder::ckDispose(sbToken)
        CkJsonObject::ckDispose(json)
        CkHttp::ckDispose(http)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; On my first try at running this code, I received the following error response:
    ; Response code: 400
    ; Response body
    ; {
    ;  "error": {
    ;   "errors": [
    ;    {
    ;     "domain": "global",
    ;     "reason": "invalid",
    ;     "message": "The combination of locationConstraint and storageClass you provided is not supported for your project"
    ;    }
    ;   ],
    ;   "code": 400,
    ;   "message": "The combination of locationConstraint and storageClass you provided is not supported for your project"
    ;  }
    ; }
    ; 

    ; This was because my storage location was a Multi-regional location, and I tried to assign the "regional" storage class,
    ; which is not allowed. 

    Debug "Response code: " + Str(responseCode)
    Debug "Response body"
    Debug CkHttpResponse::ckBodyStr(resp)

    ; A response code = 200 indicates success, and the response body contains the JSON
    ; 
    ; Response code: 200
    ; Response body
    ; {
    ;  "storageClass": "NEARLINE"
    ; }
    ; 


    CkStringBuilder::ckDispose(sbToken)
    CkJsonObject::ckDispose(json)
    CkHttp::ckDispose(http)
    CkHttpResponse::ckDispose(resp)


    ProcedureReturn
EndProcedure