Feat(StorageControl): Add samples for anywhereCache

google-cloud-storage-control/samples/storage_control_create_anywhere_cache.rb

@@ -0,0 +1,51 @@
+# Copyright 2025 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.
+
+# [START storage_control_create_anywhere_cache]
+def create_anywhere_cache bucket_name:, zone:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # Zone where you want to create cache
+  # zone = "your-zone-name"
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name = "#{parent}/anywhereCaches/#{zone}"
+
+  anywhere_cache = Google::Cloud::Storage::Control::V2::AnywhereCache.new(
+    name: name,
+    zone: zone
+  )
+
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::CreateAnywhereCacheRequest.new(
+    parent: parent,
+    anywhere_cache: anywhere_cache
+  )
+  # The request creates a new cache in the specified zone.
+  # The cache is created in the specified bucket.
+  # Call the create_anywhere_cache method.
+  result = storage_control_client.create_anywhere_cache request
+
+  if result.instance_of? Gapic::Operation
+    puts "AnywhereCache created - #{result.name}"
+  else
+    puts "operation failed"
+  end
+end
+# [END storage_control_create_anywhere_cache]
+create_anywhere_cache bucket_name: ARGV.shift, zone: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_disable_anywhere_cache.rb

@@ -0,0 +1,40 @@
+# Copyright 2025 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.
+
+# [START storage_control_disable_anywhere_cache]
+def disable_anywhere_cache bucket_name:, anywhere_cache_id:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # A value that, along with the bucket's name, uniquely identifies the cache
+  # anywhere_cache_id = value that, along with the bucket's name, uniquely identifies the cache
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name =  "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::DisableAnywhereCacheRequest.new(
+    name: name
+  )
+  # The request disables the cache, but does not delete it.
+  # The cache can be re-enabled later.
+  # Call the disable_anywhere_cache method.
+  result = storage_control_client.disable_anywhere_cache request
+  puts "AnywhereCache #{result.name} #{result.state}"
+end
+# [END storage_control_disable_anywhere_cache]
+disable_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_get_anywhere_cache.rb

@@ -0,0 +1,41 @@
+# Copyright 2025 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.
+
+# [START storage_control_get_anywhere_cache]
+def get_anywhere_cache bucket_name:, anywhere_cache_id:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # A value that, along with the bucket's name, uniquely identifies the cache
+  # anywhere_cache_id = value that, along with the bucket's name, uniquely identifies the cache
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name =  "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::GetAnywhereCacheRequest.new(
+    name: name
+  )
+  # The request retrieves the cache in the specified bucket.
+  # The cache is identified by the specified ID.
+  # The cache is in the specified bucket.
+  # Call the get_anywhere_cache method.
+  result = storage_control_client.get_anywhere_cache request
+  puts "AnywhereCache #{result.name}"
+end
+# [END storage_control_get_anywhere_cache]
+get_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_list_anywhere_caches.rb

@@ -0,0 +1,38 @@
+# Copyright 2025 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.
+
+# [START storage_control_list_anywhere_caches]
+def list_anywhere_caches bucket_name:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+
+  request = Google::Cloud::Storage::Control::V2::ListAnywhereCachesRequest.new(
+    parent: parent
+  )
+  # The request lists all caches in the specified bucket.
+  # The caches are identified by the specified bucket name.
+  # Call the list_anywhere_caches method.
+  result = storage_control_client.list_anywhere_caches request
+
+  result.response.anywhere_caches.each do |item|
+    puts item.name
+  end
+end
+# [END storage_control_list_anywhere_caches]
+list_anywhere_caches bucket_name: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_pause_anywhere_cache.rb

@@ -0,0 +1,41 @@
+# Copyright 2025 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.
+
+# [START storage_control_pause_anywhere_cache]
+def pause_anywhere_cache bucket_name:, anywhere_cache_id:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # A value that, along with the bucket's name, uniquely identifies the cache
+  # anywhere_cache_id = value that, along with the bucket's name, uniquely identifies the cache
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name =  "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::PauseAnywhereCacheRequest.new(
+    name: name
+  )
+  # The request pauses the cache, but does not delete it.
+  # The cache can be resumed later.
+  # The cache is paused in the specified bucket.
+  # Call the pause_anywhere_cache method.
+  result = storage_control_client.pause_anywhere_cache request
+  puts "AnywhereCache #{result.name} #{result.state}"
+end
+# [END storage_control_pause_anywhere_cache]
+pause_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_resume_anywhere_cache.rb

@@ -0,0 +1,41 @@
+# Copyright 2025 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.
+
+# [START storage_control_resume_anywhere_cache]
+def resume_anywhere_cache bucket_name:, anywhere_cache_id:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # A value that, along with the bucket's name, uniquely identifies the cache
+  # anywhere_cache_id = value that, along with the bucket's name, uniquely identifies the cache
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name = "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::ResumeAnywhereCacheRequest.new(
+    name: name
+  )
+  # The request resumes the cache, which was previously paused.
+  # The cache is resumed in the specified bucket.
+  # The cache is identified by the specified ID.
+  # Call the resume_anywhere_cache method.
+  result = storage_control_client.resume_anywhere_cache request
+  puts "AnywhereCache #{result.name} #{result.state}"
+end
+# [END storage_control_resume_anywhere_cache]
+resume_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__

google-cloud-storage-control/samples/storage_control_update_anywhere_cache.rb

@@ -0,0 +1,51 @@
+# Copyright 2025 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.
+
+# [START storage_control_update_anywhere_cache]
+def update_anywhere_cache bucket_name:, anywhere_cache_id:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # A value that, along with the bucket's name, uniquely identifies the cache
+  # anywhere_cache_id = value that, along with the bucket's name, uniquely identifies the cache
+  require "google/cloud/storage/control/v2"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+  parent = "projects/_/buckets/#{bucket_name}"
+  name = "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  anywhere_cache = Google::Cloud::Storage::Control::V2::AnywhereCache.new(
+    name: name,
+    ttl: 7200
+  )
+  mask = Google::Protobuf::FieldMask.new paths: ["ttl"]
+  # Create a request. Replace the placeholder values with actual data.
+  request = Google::Cloud::Storage::Control::V2::UpdateAnywhereCacheRequest.new(
+    anywhere_cache: anywhere_cache,
+    update_mask: mask
+  )
+  # The request updates the cache in the specified bucket.
+  # The cache is identified by the specified ID.
+  # Call the update_anywhere_cache method.
+  result = storage_control_client.update_anywhere_cache request
+
+  if result.instance_of? Gapic::Operation
+    puts "AnywhereCache updated - #{result.name}"
+  else
+    puts "operation failed"
+  end
+end
+# [END storage_control_update_anywhere_cache]
+update_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__