Managing turbo replication

This page describes how to use the turbo replication feature on a dual-region bucket.

Required roles

In order to get the required permissions for using turbo replication, ask your administrator to grant you the Storage Admin ( roles/storage.admin ) IAM role on the bucket.

This predefined role contains the permissions required to use turbo replication. To see the exact permissions that are required, expand the Required permissionssection:

Required permissions

storage.buckets.get
storage.buckets.update
storage.buckets.list
- This permission is only required if you plan on using the Google Cloud console to perform the instructions on this page.

You might also be able to get these permissions with custom roles or other predefined roles .

For instructions on granting roles on buckets, see Use IAM with buckets .

Set turbo replication

To enable or disable turbo replication on an existing bucket, complete the following instructions:

Console

In the Google Cloud console, go to the Cloud Storage Buckets page.

Go to Buckets
In the bucket list, click the name of the desired bucket.
Click the Configurationtab.
In the Replicationrow, click Edit.

The window that appears indicates whether you are about to Enable turbo replicationor Disable turbo replication.
Click Saveto confirm the new setting.

Command line

Use the gcloud storage buckets update command with the --rpo flag:

gcloud storage buckets update gs:// BUCKET_NAME 
--rpo= STATE

Where:

BUCKET_NAME is the name of the relevant bucket. For example, my-bucket .
STATE is ASYNC_TURBO for enabling Turbo Replication or DEFAULT for disabling Turbo Replication.

If successful, the response looks like:

Updating gs://my-bucket/...
  Completed 1

Client libraries

C++

For more information, see the Cloud Storage C++ API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 auto 
  
 updated 
  
 = 
  
 client 
 . 
 PatchBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadataPatchBuilder 
 (). 
 SetRpo 
 ( 
 gcs 
 :: 
 RpoAsyncTurbo 
 ())); 
  
 if 
  
 ( 
 ! 
 updated 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 updated 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "RPO is set to 'ASYNC_TURBO' for " 
 << 
 updated 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
 }

The following sample enables default replication on a bucket:

  namespace 
  
 gcs 
  
 = 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 storage 
 ; 
 using 
  
 :: 
 google 
 :: 
 cloud 
 :: 
 StatusOr 
 ; 
 []( 
 gcs 
 :: 
 Client 
  
 client 
 , 
  
 std 
 :: 
 string 
  
 const 
&  
 bucket_name 
 ) 
  
 { 
  
 auto 
  
 updated 
  
 = 
  
 client 
 . 
 PatchBucket 
 ( 
  
 bucket_name 
 , 
  
 gcs 
 :: 
 BucketMetadataPatchBuilder 
 (). 
 SetRpo 
 ( 
 gcs 
 :: 
 RpoDefault 
 ())); 
  
 if 
  
 ( 
 ! 
 updated 
 ) 
  
 throw 
  
 std 
 :: 
 move 
 ( 
 updated 
 ). 
 status 
 (); 
  
 std 
 :: 
 cout 
 << 
 "RPO is set to 'default' for " 
 << 
 updated 
 - 
> name 
 () 
 << 
 " 
 \n 
 " 
 ; 
 }

C#

For more information, see the Cloud Storage C# API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  // Copyright 2021 Google Inc. 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //     http://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 using 
  
 System 
 ; 
 ususing 
  
  Google 
 . 
 Cloud 
 . 
 Storage 
 . 
 V1 
 
 ; 
 public 
  
 class 
  
 SetRpoAsyncTurboSample 
 { 
  
 public 
  
 void 
  
 SetRpoAsyncTurbo 
 ( 
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 ) 
  
 { 
  
 // Enabling turbo replication requires a bucket with dual-region configuration 
  
 var 
  
 storage 
  
 = 
  
 St StorageClient 
 
 . 
  Create 
 
 ; 
  
 var 
  
 bucket 
  
 = 
  
 storage 
 . 
 GetBucket 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
 Rpo 
  
 = 
  
 "ASYNC_TURBO" 
 ; 
  
 storage 
 . 
 UpdateBucket 
 ( 
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Turbo replication enabled for bucket {bucketName}" 
 ); 
  
 } 
 }

The following sample enables default replication on a bucket:

  // Copyright 2021 Google Inc. 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //     http://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 using 
  
 System 
 ; 
 ususing 
  
  Google 
 . 
 Cloud 
 . 
 Storage 
 . 
 V1 
 
 ; 
 public 
  
 class 
  
 SetRpoDefaultSample 
 { 
  
 public 
  
 void 
  
 SetRpoDefault 
 ( 
 string 
  
 bucketName 
  
 = 
  
 "your-unique-bucket-name" 
 ) 
  
 { 
  
 var 
  
 storage 
  
 = 
  
 St StorageClient 
 
 . 
  Create 
 
 ; 
  
 var 
  
 bucket 
  
 = 
  
 storage 
 . 
 GetBucket 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
 Rpo 
  
 = 
  
 "DEFAULT" 
 ; 
  
 storage 
 . 
 UpdateBucket 
 ( 
 bucket 
 ); 
  
 Console 
 . 
 WriteLine 
 ( 
 $"Turbo replication disabled for bucket {bucketName}" 
 ); 
  
 } 
 }

Go

For more information, see the Cloud Storage Go API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  // Copyright 2021 Google LLC 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //     https://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 package 
  
 buckets 
 import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // setRPOAsyncTurbo enables turbo replication for the bucket by setting RPO to 
 // "ASYNC_TURBO". The bucket must be dual-region to use this feature. 
 func 
  
 setRPOAsyncTurbo 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 setRPO 
  
 := 
  
 storage 
 . 
  BucketAttrsToUpdate 
 
 { 
  
 RPO 
 : 
  
 storage 
 . 
  RPOAsyncTurbo 
 
 , 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Update 
 ( 
 ctx 
 , 
  
 setRPO 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Update: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Turbo replication enabled for %v" 
 , 
  
 bucketName 
 ) 
  
 return 
  
 nil 
 }

The following sample enables default replication on a bucket:

  // Copyright 2021 Google LLC 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //     https://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 package 
  
 buckets 
 import 
  
 ( 
  
 "context" 
  
 "fmt" 
  
 "io" 
  
 "time" 
  
 "cloud.google.com/go/storage" 
 ) 
 // setRPODefault disables turbo replication for the bucket by setting RPO to 
 // "DEFAULT". 
 func 
  
 setRPODefault 
 ( 
 w 
  
 io 
 . 
  Writer 
 
 , 
  
 bucketName 
  
 string 
 ) 
  
 error 
  
 { 
  
 // bucketName := "bucket-name" 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 client 
 , 
  
 err 
  
 := 
  
 storage 
 . 
 NewClient 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "storage.NewClient: %w" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 client 
 . 
 Close 
 () 
  
 ctx 
 , 
  
 cancel 
  
 := 
  
 context 
 . 
 WithTimeout 
 ( 
 ctx 
 , 
  
 time 
 . 
 Second 
 * 
 10 
 ) 
  
 defer 
  
 cancel 
 () 
  
 bucket 
  
 := 
  
 client 
 . 
  Bucket 
 
 ( 
 bucketName 
 ) 
  
 setRPO 
  
 := 
  
 storage 
 . 
  BucketAttrsToUpdate 
 
 { 
  
 RPO 
 : 
  
 storage 
 . 
  RPODefault 
 
 , 
  
 } 
  
 if 
  
 _ 
 , 
  
 err 
  
 := 
  
 bucket 
 . 
 Update 
 ( 
 ctx 
 , 
  
 setRPO 
 ); 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 fmt 
 . 
 Errorf 
 ( 
 "Bucket(%q).Update: %w" 
 , 
  
 bucketName 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
 w 
 , 
  
 "Turbo replication disabled for %v" 
 , 
  
 bucketName 
 ) 
  
 return 
  
 nil 
 }

Java

For more information, see the Cloud Storage Java API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  /* 
 * Copyright 2022 Google LLC 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 package 
  
 com.example.storage.bucket 
 ; 
 import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. Rpo 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 SetAsyncTurboRpo 
  
 { 
  
 public 
  
 static 
  
 void 
  
 setAsyncTurboRpo 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  get 
 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
  toBuilder 
 
 (). 
 setRpo 
 ( 
  Rpo 
 
 . 
 ASYNC_TURBO 
 ). 
 build 
 (). 
 update 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Turbo replication was enabled for " 
  
 + 
  
 bucketName 
 ); 
  
 } 
 }

The following sample enables default replication on a bucket:

  /* 
 * Copyright 2022 Google LLC 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 * http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 package 
  
 com.example.storage.bucket 
 ; 
 import 
  
 com.google.cloud.storage. Bucket 
 
 ; 
 import 
  
 com.google.cloud.storage. Rpo 
 
 ; 
 import 
  
 com.google.cloud.storage. Storage 
 
 ; 
 import 
  
 com.google.cloud.storage. StorageOptions 
 
 ; 
 public 
  
 class 
 SetDefaultRpo 
  
 { 
  
 public 
  
 static 
  
 void 
  
 setDefaultRpo 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 bucketName 
 ) 
  
 { 
  
 // The ID of your GCP project 
  
 // String projectId = "your-project-id"; 
  
 // The ID of your GCS bucket 
  
 // String bucketName = "your-unique-bucket-name"; 
  
  Storage 
 
  
 storage 
  
 = 
  
  StorageOptions 
 
 . 
 newBuilder 
 (). 
 setProjectId 
 ( 
 projectId 
 ). 
 build 
 (). 
  getService 
 
 (); 
  
  Bucket 
 
  
 bucket 
  
 = 
  
 storage 
 . 
  get 
 
 ( 
 bucketName 
 ); 
  
 bucket 
 . 
  toBuilder 
 
 (). 
 setRpo 
 ( 
  Rpo 
 
 . 
 DEFAULT 
 ). 
 build 
 (). 
 update 
 (); 
  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Replication was set to default for " 
  
 + 
  
 bucketName 
 ); 
  
 } 
 }

Node.js

For more information, see the Cloud Storage Node.js API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  // Copyright 2022 Google LLC 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //      http://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 /** 
 * This application demonstrates how to perform basic operations on buckets with 
 * the Google Cloud Storage API. 
 * 
 * For more information, see the README.md under /storage and the documentation 
 * at https://cloud.google.com/storage/docs. 
 */ 
 function 
  
 main 
 ( 
 bucketName 
  
 = 
  
 'my-bucket' 
 ) 
  
 { 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // The name of your GCS bucket in a dual-region 
  
 // const bucketName = 'Name of a bucket, e.g. my-bucket'; 
  
 // Imports the Google Cloud client library 
  
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
  
 // Creates a client 
  
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
  
 // Enable turbo replication for the bucket by setting rpo to ASYNC_TURBO. 
  
 // The bucket must be a dual-region bucket. 
  
 async 
  
 function 
  
 setRPOAsyncTurbo 
 () 
  
 { 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
 setMetadata 
 ({ 
  
 rpo 
 : 
  
 'ASYNC_TURBO' 
 , 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Turbo replication enabled for 
 ${ 
 bucketName 
 } 
 .` 
 ); 
  
 } 
  
 setRPOAsyncTurbo 
 (); 
 } 
 process 
 . 
 on 
 ( 
 'unhandledRejection' 
 , 
  
 err 
  
 = 
>  
 { 
  
 console 
 . 
 error 
 ( 
 err 
 . 
 message 
 ); 
  
 process 
 . 
 exitCode 
  
 = 
  
 1 
 ; 
 }); 
 main 
 (... 
 process 
 . 
 argv 
 . 
 slice 
 ( 
 2 
 ));

The following sample enables default replication on a bucket:

  // Copyright 2022 Google LLC 
 // 
 // Licensed under the Apache License, Version 2.0 (the "License"); 
 // you may not use this file except in compliance with the License. 
 // You may obtain a copy of the License at 
 // 
 //      http://www.apache.org/licenses/LICENSE-2.0 
 // 
 // Unless required by applicable law or agreed to in writing, software 
 // distributed under the License is distributed on an "AS IS" BASIS, 
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 // See the License for the specific language governing permissions and 
 // limitations under the License. 
 /** 
 * This application demonstrates how to perform basic operations on buckets with 
 * the Google Cloud Storage API. 
 * 
 * For more information, see the README.md under /storage and the documentation 
 * at https://cloud.google.com/storage/docs. 
 */ 
 function 
  
 main 
 ( 
 bucketName 
  
 = 
  
 'my-bucket' 
 ) 
  
 { 
  
 /** 
 * TODO(developer): Uncomment the following lines before running the sample. 
 */ 
  
 // The name of your GCS bucket in a dual-region 
  
 // const bucketName = 'Name of a bucket, e.g. my-bucket'; 
  
 // Imports the Google Cloud client library 
  
 const 
  
 { 
 Storage 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/storage 
' 
 ); 
  
 // Creates a client 
  
 const 
  
 storage 
  
 = 
  
 new 
  
 Storage 
 (); 
  
 // Disable turbo replication for the bucket by setting RPO to default. 
  
 // The bucket must be a dual-region bucket. 
  
 async 
  
 function 
  
 setRPODefault 
 () 
  
 { 
  
 await 
  
 storage 
 . 
 bucket 
 ( 
 bucketName 
 ). 
 setMetadata 
 ({ 
  
 rpo 
 : 
  
 'DEFAULT' 
 , 
  
 }); 
  
 console 
 . 
 log 
 ( 
 `Turbo replication disabled for 
 ${ 
 bucketName 
 } 
 .` 
 ); 
  
 } 
  
 setRPODefault 
 (); 
 } 
 process 
 . 
 on 
 ( 
 'unhandledRejection' 
 , 
  
 err 
  
 = 
>  
 { 
  
 console 
 . 
 error 
 ( 
 err 
 . 
 message 
 ); 
  
 process 
 . 
 exitCode 
  
 = 
  
 1 
 ; 
 }); 
 main 
 (... 
 process 
 . 
 argv 
 . 
 slice 
 ( 
 2 
 ));

PHP

For more information, see the Cloud Storage PHP API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

 < ?php 
 /** 
 * Copyright 2021 Google LLC 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 /** 
 * For instructions on how to run the full sample: 
 * 
 * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md 
 */ 
 namespace Google\Cloud\Samples\Storage; 
 use Google\Cloud\Storage\StorageClient; 
 /** 
 * Set the bucket's Turbo Replication(rpo) setting to `ASYNC_TURBO`. 
 * The bucket must be a dual-region bucket. 
 * 
 * @param string $bucketName the name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function set_rpo_async_turbo(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $rpo = 'ASYNC_TURBO'; 
 $bucket->update([ 
 'rpo' => $rpo 
 ]); 
 printf( 
 'The replication behavior or recovery point objective (RPO) has been set to ASYNC_TURBO for %s.' . PHP_EOL, 
 $bucketName 
 ); 
 } 
 // The following 2 lines are only needed to run the samples 
 require_once __DIR__ . '/../../testing/sample_helpers.php'; 
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

The following sample enables default replication on a bucket:

 < ?php 
 /** 
 * Copyright 2021 Google LLC 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License. 
 */ 
 /** 
 * For instructions on how to run the full sample: 
 * 
 * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/storage/README.md 
 */ 
 namespace Google\Cloud\Samples\Storage; 
 use Google\Cloud\Storage\StorageClient; 
 /** 
 * Set the bucket's replication behavior or recovery point objective (RPO) to `DEFAULT`. 
 * 
 * @param string $bucketName the name of your Cloud Storage bucket. 
 *        (e.g. 'my-bucket') 
 */ 
 function set_rpo_default(string $bucketName): void 
 { 
 $storage = new StorageClient(); 
 $bucket = $storage->bucket($bucketName); 
 $rpo = 'DEFAULT'; 
 // Updating the rpo value of a multi-region bucket to DEFAULT has no effect 
 // and updating the rpo value of a regional bucket will throw an exception. 
 $bucket->update([ 
 'rpo' => $rpo 
 ]); 
 printf( 
 'The replication behavior or recovery point objective (RPO) has been set to DEFAULT for %s.' . PHP_EOL, 
 $bucketName 
 ); 
 } 
 // The following 2 lines are only needed to run the samples 
 require_once __DIR__ . '/../../testing/sample_helpers.php'; 
 \Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

Python

For more information, see the Cloud Storage Python API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  #!/usr/bin/env python 
 # Copyright 2021 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the 'License'); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 import 
  
 sys 
 """Sample that sets RPO (Recovery Point Objective) to ASYNC_TURBO 
 This sample is used on this page: 
 https://cloud.google.com/storage/docs/managing-turbo-replication 
 For more information, see README.md. 
 """ 
 from 
  
 google.cloud 
  
 import 
  storage 
 
 from 
  
 google.cloud.storage.constants 
  
 import 
 RPO_ASYNC_TURBO 
 def 
  
 set_rpo_async_turbo 
 ( 
 bucket_name 
 ): 
  
 """Sets the RPO to ASYNC_TURBO, enabling the turbo replication feature""" 
 # The ID of your GCS bucket 
 # bucket_name = "my-bucket" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
  rpo 
 
 = 
 RPO_ASYNC_TURBO 
 bucket 
 . 
 patch 
 () 
 print 
 ( 
 f 
 "RPO is set to ASYNC_TURBO for 
 { 
 bucket 
 . 
 name 
 } 
 ." 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 set_rpo_async_turbo 
 ( 
 bucket_name 
 = 
 sys 
 . 
 argv 
 [ 
 1 
 ])

The following sample enables default replication on a bucket:

  #!/usr/bin/env python 
 # Copyright 2021 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the 'License'); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 import 
  
 sys 
 """Sample that sets the replication behavior or recovery point objective (RPO) to default. 
 This sample is used on this page: 
 https://cloud.google.com/storage/docs/managing-turbo-replication 
 For more information, see README.md. 
 """ 
 from 
  
 google.cloud 
  
 import 
  storage 
 
 from 
  
 google.cloud.storage.constants 
  
 import 
 RPO_DEFAULT 
 def 
  
 set_rpo_default 
 ( 
 bucket_name 
 ): 
  
 """Sets the RPO to DEFAULT, disabling the turbo replication feature""" 
 # The ID of your GCS bucket 
 # bucket_name = "my-bucket" 
 storage_client 
 = 
  storage 
 
 . 
  Client 
 
 () 
 bucket 
 = 
 storage_client 
 . 
  bucket 
 
 ( 
 bucket_name 
 ) 
 bucket 
 . 
  rpo 
 
 = 
 RPO_DEFAULT 
 bucket 
 . 
 patch 
 () 
 print 
 ( 
 f 
 "RPO is set to DEFAULT for 
 { 
 bucket 
 . 
 name 
 } 
 ." 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 set_rpo_default 
 ( 
 bucket_name 
 = 
 sys 
 . 
 argv 
 [ 
 1 
 ])

Ruby

For more information, see the Cloud Storage Ruby API reference documentation .

To authenticate to Cloud Storage, set up Application Default Credentials. For more information, see Set up authentication for client libraries .

The following sample enables turbo replication on a bucket:

  # Copyright 2021 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 def 
  
 set_rpo_async_turbo 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
 , 
  
 location 
 : 
  
 "ASIA" 
  
 bucket 
 . 
  rpo 
 
  
 = 
  
 :ASYNC_TURBO 
  
 puts 
  
 "Turbo replication is enabled for 
 #{ 
 bucket_name 
 } 
 ." 
 end 
 set_rpo_async_turbo 
  
 bucket_name 
 : 
  
 ARGV 
 . 
 shift 
  
 if 
  
 $PROGRAM_NAME 
  
 == 
  
 __FILE__

The following sample enables default replication on a bucket:

  # Copyright 2021 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     http://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 def 
  
 set_rpo_default 
  
 bucket_name 
 : 
  
 # The ID of your GCS bucket 
  
 # bucket_name = "your-unique-bucket-name" 
  
 require 
  
 "google/cloud/storage" 
  
 storage 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
  Storage 
 
 . 
  new 
 
  
 bucket 
  
 = 
  
 storage 
 . 
 bucket 
  
 bucket_name 
  
 bucket 
 . 
  rpo 
 
  
 = 
  
 :DEFAULT 
  
 puts 
  
 "The replication behavior or recovery point objective (RPO) for 
 #{ 
 bucket_name 
 } 
 is set to default." 
 end 
 set_rpo_default 
  
 bucket_name 
 : 
  
 ARGV 
 . 
 shift 
  
 if 
  
 $PROGRAM_NAME 
  
 == 
  
 __FILE__

Managing turbo replication

Required roles

Required permissions

Set turbo replication

Console

Command line

Client libraries

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

REST APIs

JSON API

XML API

Check a bucket's replication status

Console

Command line

Client libraries

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

REST APIs

JSON API

XML API

What's next

Managing turbo replication Stay organized with collections Save and categorize content based on your preferences.

Required roles

Required permissions

Set turbo replication

Console

Command line

Client libraries

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

REST APIs

JSON API

XML API

Check a bucket's replication status

Console

Command line

Client libraries

C++

C#

Go

Java

Node.js

PHP

Python

Ruby

REST APIs

JSON API

XML API

What's next

Managing turbo replication