google-cloud-storage 1.43.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5dbc607cd09b7198bb96445d9ed85ef7b883a88660f4d320602837bbc543fc0
-  data.tar.gz: 33ee9b85da98c870e73b0bfc6126087c59925693997c14b7c61e59ad652f551e
+  metadata.gz: 1a00be88dfffe243057e1ffe70891fabb483caadc76a7a37e8b82dcdb5f95395
+  data.tar.gz: 2190d664457e1419b26b95266d8911728a612647d404790b35f37586dfe59e02
 SHA512:
-  metadata.gz: 7d70f656ac06a5c65b75a99883aa4298222dbf4cf2b9a9fbfa252d2c7800486bf1e7bf77b50ea0d64431dc50008f680b0525c0fb619f7244508fad07862941a8
-  data.tar.gz: c4af126c15814b8a02e17282cb940067b2cd10e6cf5081b4c525a91e8993b7b717ab877d26c545ea5b7d66e0213e4edb7e65df8826369f21fa400017a6298f02
+  metadata.gz: e5b129dba88921e6aeec6476d60bb17ee603f0cb641194bbeb09531aff568c2290e17ab3f0f290d87976a0b0f35d4f10674dab8fea6deef70d424738a4ce767c
+  data.tar.gz: 87e4411cda889bb7bdbf0ccddc2a343ae475614c5cab19d8461bcd646ac78016b6be35975255e14c1af1efcd3c5087c9b769b674260a82f936ef4c0456566a19

data/AUTHENTICATION.md

@@ -112,15 +112,6 @@ those that produce
 post objects. For these methods, authentication using a service account JSON key file
 is required.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires a **Project ID** and **Service Account Credentials** to
@@ -130,31 +121,22 @@ connect to most services with google-cloud-storage.
 If you are not running this client on Google Compute Engine, you need a Google
 Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
+1. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 1. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
-
-   If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
-   ![Re-use an existing service account][reuse-service-account]
+   If you want to re-use an existing service account, you can easily generate 
+   a new key file. Just select the account you wish to re-use click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+### 1.45.0 (2023-11-06)
+
+#### Features
+
+* added autoclass v2.1 features ([#23483](https://github.com/googleapis/google-cloud-ruby/issues/23483)) 
+
+### 1.44.0 (2022-11-02)
+
+#### Features
+
+* support autoclass 
+
 ### 1.43.0 (2022-09-30)
 
 #### Features

data/lib/google/cloud/storage/bucket.rb

@@ -109,6 +109,15 @@ module Google
           @gapi.id
         end
 
+        ##
+        # The autoclass configuration of the bucket
+        #
+        # @return [Google::Apis::StorageV1::Bucket::Autoclass]
+        #
+        def autoclass
+          @gapi.autoclass
+        end
+
         ##
         # The name of the bucket.
         #
@@ -407,6 +416,77 @@ module Google
           patch_gapi! :storage_class
         end
 
+        ##
+        # Whether Autoclass is enabled for the bucket.
+        #
+        # @return [Boolean]
+        #
+        def autoclass_enabled
+          @gapi.autoclass&.enabled?
+        end
+
+        ##
+        # Toggle time of the autoclass
+        #
+        # @return [DateTime]
+        #
+        def autoclass_toggle_time
+          @gapi.autoclass&.toggle_time
+        end
+
+        ##
+        # Terminal Storage class of the autoclass
+        #
+        # @return [String]
+        #
+        def autoclass_terminal_storage_class
+          @gapi.autoclass&.terminal_storage_class
+        end
+
+        ##
+        # Update time at which the autoclass terminal storage class was last modified
+        #
+        # @return [DateTime]
+        #
+        def autoclass_terminal_storage_class_update_time
+          @gapi.autoclass&.terminal_storage_class_update_time
+        end
+
+        ##
+        # Updates bucket's autoclass configuration. This defines the default class for objects in the
+        # bucket and down/up-grades the storage class of objects based on the access patterns.
+        # Accepted values are `:false`, and `:true`.
+        #
+        # For more information, see [Storage
+        # Classes](https://cloud.google.com/storage/docs/using-autoclass).
+        #
+        # @param [Boolean] toggle for autoclass configuration of the bucket.
+        #
+        def autoclass_enabled= toggle
+          @gapi.autoclass ||= API::Bucket::Autoclass.new
+          @gapi.autoclass.enabled = toggle
+          patch_gapi! :autoclass
+        end
+
+        ##
+        # Update method to update all attributes of autoclass of a bucket
+        # It accepts params as a Hash of attributes in the following format:
+        #
+        #     { enabled: true, terminal_storage_class: "ARCHIVE" }
+        #
+        # terminal_storage_class field is optional. It defaults to `NEARLINE`.
+        # Valid terminal_storage_class values are `NEARLINE` and `ARCHIVE`.
+        #
+        # @param [Hash(String => String)] autoclass_attributes
+        #
+        def update_autoclass autoclass_attributes
+          @gapi.autoclass ||= API::Bucket::Autoclass.new
+          autoclass_attributes.each do |k, v|
+            @gapi.autoclass.send "#{k}=", v
+          end
+          patch_gapi! :autoclass
+        end
+
         ##
         # Whether [Object
         # Versioning](https://cloud.google.com/storage/docs/object-versioning)

data/lib/google/cloud/storage/project.rb

@@ -94,6 +94,41 @@ module Google
             service.project_service_account.email_address
         end
 
+        ##
+        # Add custom Google extension headers to the requests that use the signed URLs.
+        #
+        # @param [Hash] headers Google extension headers (custom HTTP headers that
+        #   begin with `x-goog-`) to be included in requests that use the signed URLs.
+        #   Provide headers as a key/value array, where the key is
+        #   the header name, and the value is an array of header values.
+        #   For headers with multiple values, provide values as a simple
+        #   array, or a comma-separated string. For a reference of allowed
+        #   headers, see [Reference Headers](https://cloud.google.com/storage/docs/xml-api/reference-headers).
+        #
+        # @return [Google::Cloud::Storage::Project] Returns the Project for method chaining
+        #
+        def add_custom_headers headers
+          @service.add_custom_headers headers
+          self
+        end
+
+        ##
+        # Add custom Google extension header to the requests that use the signed URLs.
+        #
+        # @param [String] header_name Name of Google extension header (custom HTTP header that
+        #   begin with `x-goog-`) to be included in requests that use the signed URLs.
+        #   For a reference of allowed headers, see
+        #   [Reference Headers](https://cloud.google.com/storage/docs/xml-api/reference-headers).
+        # @param [Object] header_value Valid value of the Google extension header being added.
+        #   For headers with multiple values, provide values as a simple array, or a comma-separated string.
+        #
+        # @return [Google::Cloud::Storage::Project] Returns the Project for method chaining
+        #
+        def add_custom_header header_name, header_value
+          @service.add_custom_header header_name, header_value
+          self
+        end
+
         ##
         # Retrieves a list of buckets for the given project.
         #
@@ -327,6 +362,11 @@ module Google
         #   other than the current project, and that project is authorized for
         #   the currently authenticated service account, transit costs will be
         #   billed to the given project. The default is `nil`.
+        # @param [Boolean] autoclass_enabled The bucket's autoclass configuration.
+        #   Buckets can have either StorageClass OLM rules or Autoclass, but
+        #   not both. When Autoclass is enabled on a bucket, adding StorageClass
+        #   OLM rules will result in failure. For more information, see
+        #   [Autoclass](https://cloud.google.com/storage/docs/autoclass).
         #
         #   The value provided will be applied to all operations on the returned
         #   bucket instance and its files.
@@ -375,7 +415,8 @@ module Google
                           website_404: nil,
                           versioning: nil,
                           requester_pays: nil,
-                          user_project: nil
+                          user_project: nil,
+                          autoclass_enabled: false
           params = {
             name: bucket_name,
             location: location,
@@ -386,6 +427,7 @@ module Google
           updater = Bucket::Updater.new(new_bucket).tap do |b|
             b.logging_bucket = logging_bucket unless logging_bucket.nil?
             b.logging_prefix = logging_prefix unless logging_prefix.nil?
+            b.autoclass_enabled = autoclass_enabled
             b.storage_class = storage_class unless storage_class.nil?
             b.website_main = website_main unless website_main.nil?
             b.website_404 = website_404 unless website_404.nil?

data/lib/google/cloud/storage/service.rb

@@ -43,7 +43,7 @@ module Google
                        timeout: nil, open_timeout: nil, read_timeout: nil,
                        send_timeout: nil, host: nil, quota_project: nil,
                        max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                       multiplier: nil
+                       multiplier: nil, upload_chunk_size: nil
           @project = project
           @credentials = credentials
           @service = API::StorageService.new
@@ -65,6 +65,7 @@ module Google
           @service.request_options.max_interval = max_interval if max_interval
           @service.request_options.multiplier = multiplier if multiplier
           @service.request_options.add_invocation_id_header = true
+          @service.request_options.upload_chunk_size = upload_chunk_size if upload_chunk_size
           @service.authorization = @credentials.client if @credentials
           @service.root_url = host if host
         end
@@ -794,6 +795,18 @@ module Google
           "#{self.class}(#{@project})"
         end
 
+        ##
+        # Add custom Google extension headers to the requests that use the signed URLs.
+        def add_custom_headers headers
+          @service.request_options.header.merge! headers
+        end
+
+        ##
+        # Add custom Google extension header to the requests that use the signed URLs.
+        def add_custom_header header_name, header_value
+          @service.request_options.header[header_name] = header_value
+        end
+
         protected
 
         def user_project user_project

data/lib/google/cloud/storage/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Storage
-      VERSION = "1.43.0".freeze
+      VERSION = "1.45.0".freeze
     end
   end
 end

data/lib/google/cloud/storage.rb

@@ -67,6 +67,9 @@ module Google
       # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
+      # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
+      #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
+      #                  the complete file regardless of size, pass 0 as the chunk size.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
       # @param [String] keyfile Alias for the `credentials` argument.
       #   Deprecated.
@@ -89,7 +92,7 @@ module Google
                    timeout: nil, open_timeout: nil, read_timeout: nil,
                    send_timeout: nil, endpoint: nil, project: nil, keyfile: nil,
                    max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                   multiplier: nil
+                   multiplier: nil, upload_chunk_size: nil
         scope             ||= configure.scope
         retries           ||= configure.retries
         timeout           ||= configure.timeout
@@ -102,6 +105,7 @@ module Google
         base_interval     ||= configure.base_interval
         max_interval      ||= configure.max_interval
         multiplier        ||= configure.multiplier
+        upload_chunk_size ||= configure.upload_chunk_size
 
         unless credentials.is_a? Google::Auth::Credentials
           credentials = Storage::Credentials.new credentials, scope: scope
@@ -117,7 +121,7 @@ module Google
             read_timeout: read_timeout, send_timeout: send_timeout,
             host: endpoint, quota_project: configure.quota_project,
             max_elapsed_time: max_elapsed_time, base_interval: base_interval,
-            max_interval: max_interval, multiplier: multiplier
+            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size
           )
         )
       end
@@ -141,6 +145,9 @@ module Google
       # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
+      # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
+      #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
+      #                  the complete file regardless of size, pass 0 as the chunk size.
       #
       # @return [Google::Cloud::Storage::Project]
       #
@@ -159,7 +166,7 @@ module Google
       def self.anonymous retries: nil, timeout: nil, open_timeout: nil,
                          read_timeout: nil, send_timeout: nil, endpoint: nil,
                          max_elapsed_time: nil, base_interval: nil, max_interval: nil,
-                         multiplier: nil
+                         multiplier: nil, upload_chunk_size: nil
         open_timeout ||= timeout
         read_timeout ||= timeout
         send_timeout ||= timeout
@@ -168,7 +175,7 @@ module Google
             nil, nil, retries: retries, timeout: timeout, open_timeout: open_timeout,
             read_timeout: read_timeout, send_timeout: send_timeout, host: endpoint,
             max_elapsed_time: max_elapsed_time, base_interval: base_interval,
-            max_interval: max_interval, multiplier: multiplier
+            max_interval: max_interval, multiplier: multiplier, upload_chunk_size: upload_chunk_size
           )
         )
       end
@@ -202,6 +209,7 @@ module Google
       # * `open_timeout` - (Integer) How long, in seconds, before failed connections time out.
       # * `read_timeout` - (Integer) How long, in seconds, before requests time out.
       # * `send_timeout` - (Integer) How long, in seconds, before receiving response from server times out.
+      # * `upload_chunk_size` - (Integer) The chunk size of storage upload, in bytes.
       #
       # @return [Google::Cloud::Config] The configuration object the
       #   Google::Cloud::Storage library uses.

data/lib/google-cloud-storage.rb

@@ -55,6 +55,9 @@ module Google
     # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
     # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
     # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
+    # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
+    #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
+    #                  the complete file regardless of size, pass 0 as the chunk size.
     #
     # @return [Google::Cloud::Storage::Project]
     #
@@ -74,7 +77,7 @@ module Google
     #   readonly_storage = gcloud.storage scope: readonly_scope
     #
     def storage scope: nil, retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil,
-                max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil
+                max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil, upload_chunk_size: nil
       Google::Cloud.storage @project, @keyfile, scope: scope,
                                                 retries: (retries || @retries),
                                                 timeout: (timeout || @timeout),
@@ -84,7 +87,8 @@ module Google
                                                 max_elapsed_time: max_elapsed_time,
                                                 base_interval: base_interval,
                                                 max_interval: max_interval,
-                                                multiplier: multiplier
+                                                multiplier: multiplier,
+                                                upload_chunk_size: upload_chunk_size
     end
 
     ##
@@ -120,6 +124,9 @@ module Google
     # @param [Integer] open_timeout How long, in seconds, before failed connections time out. Optional.
     # @param [Integer] read_timeout How long, in seconds, before requests time out. Optional.
     # @param [Integer] send_timeout How long, in seconds, before receiving response from server times out. Optional.
+    # @param [Integer] upload_chunk_size The chunk size of storage upload, in bytes.
+    #                  The default value is 100 MB, i.e. 104_857_600 bytes. To disable chunking and upload
+    #                  the complete file regardless of size, pass 0 as the chunk size.
     #
     # @return [Google::Cloud::Storage::Project]
     #
@@ -134,7 +141,8 @@ module Google
     #
     def self.storage project_id = nil, credentials = nil, scope: nil,
                      retries: nil, timeout: nil, open_timeout: nil, read_timeout: nil, send_timeout: nil,
-                     max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil
+                     max_elapsed_time: nil, base_interval: nil, max_interval: nil, multiplier: nil,
+                     upload_chunk_size: nil
       require "google/cloud/storage"
       Google::Cloud::Storage.new project_id: project_id,
                                  credentials: credentials,
@@ -147,7 +155,8 @@ module Google
                                  max_elapsed_time: max_elapsed_time,
                                  base_interval: base_interval,
                                  max_interval: max_interval,
-                                 multiplier: multiplier
+                                 multiplier: multiplier,
+                                 upload_chunk_size: upload_chunk_size
     end
   end
 end
@@ -182,6 +191,7 @@ Google::Cloud.configure.add_config! :storage do |config|
   config.add_field! :open_timeout, nil, match: Integer
   config.add_field! :read_timeout, nil, match: Integer
   config.add_field! :send_timeout, nil, match: Integer
+  config.add_field! :upload_chunk_size, nil, match: Integer
   # TODO: Remove once discovery document is updated.
   config.add_field! :endpoint, "https://storage.googleapis.com/", match: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-storage
 version: !ruby/object:Gem::Version
-  version: 1.43.0
+  version: 1.45.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.29.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.29.0
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +255,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.13
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 description: google-cloud-storage is the official library for Google Cloud Storage.
 email:
 - mike@blowmage.com
@@ -318,7 +332,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage