Dart

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.

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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..
  final sbToken = CkStringBuilder();
  sbToken.loadFile('qa_data/tokens/googleCloudStorageAccessToken.txt', 'utf-8');

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

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

  final json = CkJsonObject();
  // Be careful if using the "regional" storage class.  See the note below about the 400 error response.
  json.updateString('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"

  final http = CkHttp();
  http.authToken = sbToken.getAsString();

  http.setUrlVar('bucket_name', 'chilkat-ocean');
  final url = 'https://www.googleapis.com/storage/v1/b/{\$bucket_name}?fields=storageClass';
  final resp = CkHttpResponse();
  try {
    http.httpJson('PUT', url, json, 'application/json', resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final responseCode = resp.statusCode;
  if (responseCode == 401) {
    print(resp.bodyStr);
    print('If invalid credentials, then it is likely the access token expired.');
    print('Your app should automatically fetch a new access token and re-try.');
    return;
  }

  // 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. 

  print('Response code: $responseCode');
  print('Response body');
  print(resp.bodyStr);

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