Anywhere cache samples v2

google-cloud-storage-control/README.md

@@ -132,3 +132,8 @@ The `google-apis-` clients have wide coverage across Google services, so you
 might need to use one if there is no modern client available for the service.
 However, if a modern client is available, we generally recommend it over the
 older `google-apis-` clients.
+
+## Note
+
+Tests for Anywhere cache Sample are not included due to the long operation times typical for cache operations.
+

google-cloud-storage-control/samples/acceptance/storage_control_anywhere_cache_test.rb

@@ -0,0 +1,89 @@
+# 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.
+
+require_relative "helper"
+require_relative "../storage_control_create_anywhere_cache"
+require_relative "../storage_control_list_anywhere_caches"
+require_relative "../storage_control_get_anywhere_cache"
+require_relative "../storage_control_update_anywhere_cache"
+require_relative "../storage_control_pause_anywhere_cache"
+require_relative "../storage_control_resume_anywhere_cache"
+require_relative "../storage_control_disable_anywhere_cache"
+
+# require 'pry'
+
+describe "Storage Control Anywhere Cache" do
+  let(:bucket_name) { random_bucket_name }
+  let(:storage_client) { Google::Cloud::Storage.new }
+  let(:zone) {'us-east1-b'}
+#   let(:zone) {@bucket.location}
+
+  before :all do
+    @bucket= storage_client.bucket bucket_name
+     @bucket = create_bucket_helper bucket_name
+  end
+
+  # after do
+  #   delete_bucket_helper bucket_name
+  # end
+
+  it "create Anywhere cache" do
+    create_anywhere_cache bucket_name: bucket_name, zone: zone
+  end
+
+  # it "list Anywhere cache" do
+  #   # create_anywhere_cache bucket_name: bucket_name, zone: zone
+
+  #   out, _err = capture_io do
+  #       list_anywhere_caches bucket_name: bucket_name
+  #   end
+
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone}"
+  # end
+
+  # it "Get Anywhere cache" do
+  #   out, _err = capture_io do
+  #       get_anywhere_cache bucket_name: bucket_name, anywhere_cache_id: zone
+  #   end
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone}"
+  # end
+
+  # it "Pause Anywhere cache" do
+  #   out, _err = capture_io do
+  #       pause_anywhere_cache bucket_name: bucket_name, anywhere_cache_id: zone
+  #   end
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone} paused"
+  # end
+
+  # it "Resume Anywhere cache" do
+  #   out, _err = capture_io do
+  #       resume_anywhere_cache bucket_name: bucket_name, anywhere_cache_id: zone
+  #   end
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone} running"
+  # end
+
+  # it "Disable Anywhere cache" do
+  #   out, _err = capture_io do
+  #      disable_anywhere_cache bucket_name: bucket_name, anywhere_cache_id: zone
+  #   end
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone} disabled"
+  # end
+
+  # it "Update Anywhere cache" do
+  #   out, _err = capture_io do
+  #       update_anywhere_cache bucket_name: bucket_name, anywhere_cache_id: zone
+  #   end
+  #   assert_includes out, "#{bucket_name}/anywhereCaches/#{zone}"
+  # end
+end

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

@@ -0,0 +1,56 @@
+# 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]
+require "google/cloud/storage/control"
+
+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"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  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.
+  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.
+  begin
+    operation = storage_control_client.create_anywhere_cache request
+
+    puts "********************AnywhereCache operation created - #{operation.name}"
+    while !operation.done?
+      sleep 3600 # Wait for 1 hour before checking again
+      operation.refresh!
+    end
+    puts "********************AnywhereCache create operation completed - #{operation.name}"
+
+  rescue StandardError => e
+    puts "Error creating AnywhereCache: #{e.message}"
+  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,44 @@
+# 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]
+require "google/cloud/storage/control"
+
+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 = "us-east1-b"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  parent = "projects/_/buckets/#{bucket_name}"
+  name =  "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request.
+  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.
+  begin
+    result = storage_control_client.disable_anywhere_cache request
+    puts "AnywhereCache #{result.name} #{result.state}"
+  rescue StandardError => e
+    puts "Error disabling AnywhereCache: #{e.message}"
+  end
+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,46 @@
+# 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]
+require "google/cloud/storage/control"
+
+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 = "us-east1-b"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  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.
+
+  begin
+    result = storage_control_client.get_anywhere_cache request
+    puts "AnywhereCache fetched - #{result.name}"
+  rescue StandardError => e
+    puts "Error fetching AnywhereCache: #{e.message}"
+  end
+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,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_list_anywhere_caches]
+require "google/cloud/storage/control"
+
+def list_anywhere_caches bucket_name:
+  # The ID of your GCS bucket
+  # bucket_name = "your-unique-bucket-name"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  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.
+  begin
+    result = storage_control_client.list_anywhere_caches request
+    result.response.anywhere_caches.each do |item|
+      puts item.name
+    end
+  rescue StandardError => e
+    puts "Error listing AnywhereCaches: #{e.message}"
+  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,45 @@
+# 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]
+require "google/cloud/storage/control"
+
+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 = "us-east1-b"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  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.
+  begin
+    result = storage_control_client.pause_anywhere_cache request
+    puts "AnywhereCache #{result.name} #{result.state}"
+  rescue StandardError => e
+    puts "Error pausing AnywhereCache: #{e.message}"
+  end
+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,45 @@
+# 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]
+require "google/cloud/storage/control"
+
+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 = "us-east1-b"
+
+  # Create a client object. The client can be reused for multiple calls.
+  storage_control_client = Google::Cloud::Storage::Control.storage_control
+  parent = "projects/_/buckets/#{bucket_name}"
+  name = "#{parent}/anywhereCaches/#{anywhere_cache_id}"
+
+  # Create a request.
+  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.
+  begin
+    result = storage_control_client.resume_anywhere_cache request
+    puts "AnywhereCache #{result.name} #{result.state}"
+  rescue StandardError => e
+    puts "Error resuming AnywhereCache: #{e.message}"
+  end
+end
+# [END storage_control_resume_anywhere_cache]
+resume_anywhere_cache bucket_name: ARGV.shift, anywhere_cache_id: ARGV.shift if $PROGRAM_NAME == __FILE__