google-cloud-storage 1.44.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7829a0c2c9afddc17d897bd33e73af95e922a4767bfd6d6e8474eec0bac46194
-  data.tar.gz: 41f4328eb840bb9f2373cd291e2271e95d6f066db1a0dd62dbb7354e9e9c8c0e
+  metadata.gz: 9180138623d24136aba3789a2999158c8e1936ccc483be54e96d7ad5ce0270cd
+  data.tar.gz: db71d2a866acb5b3c63a55d26393ef4d4b05dbdbdc529f51b4e8343d0674ec3d
 SHA512:
-  metadata.gz: ec55a9d4632ee6f5d3637e6b4dc5d156ba45fc01da7b20d7f2e69a1fa4945d55d300385ee6aafba2244edcdf8fe0f36be1340adb28c074920cfad4eca667af21
-  data.tar.gz: 2194c91da01d5719d35756e3a9e1aceb49bfd9e15fb0466ddd8a7c4fae64074e06be41ea14437d0ed8698c777ab7c81f5ea6d90d5932336603c7dd99c5907558
+  metadata.gz: 33f397b67897fb16738284a45998c6df621cf7cc7a26cf57582c092ec0ff40b3fa38c2cc7a74489ff46debcad240cb82a1e4293302dd0eb6214e261aa7972e4d
+  data.tar.gz: d52e0f8e792f8dc9359d24c58cba4c1dbc7714114078be630c40ce8d652bef3e4b336785c3b7f440b6df41f61f2699fa69d3073113e1c985a504d69a24debf2c

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.46.0 (2024-01-08)
+
+#### Features
+
+* support match_glob for Object.list 
+
+### 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

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

@@ -434,6 +434,24 @@ module Google
           @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.
@@ -442,9 +460,6 @@ module Google
         # For more information, see [Storage
         # Classes](https://cloud.google.com/storage/docs/using-autoclass).
         #
-        # Note: Only patch requests that disable autoclass are currently supported.
-        # To enable autoclass, you must set it at bucket creation time.
-        #
         # @param [Boolean] toggle for autoclass configuration of the bucket.
         #
         def autoclass_enabled= toggle
@@ -453,6 +468,25 @@ module Google
           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)
@@ -1265,6 +1299,9 @@ module Google
         #   `prefixes` are omitted.
         # @param [String] token A previously-returned page token representing
         #   part of the larger set of results to view.
+        # @param [String] match_glob A glob pattern used to filter results returned in items (e.g. `foo*bar`).
+        #    The string value must be UTF-8 encoded. See:
+        #    https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-object-glob
         # @param [Integer] max Maximum number of items plus prefixes to return.
         #   As duplicate prefixes are omitted, fewer total results may be
         #   returned than requested. The default value of this parameter is
@@ -1300,14 +1337,17 @@ module Google
         #   end
         #
         def files prefix: nil, delimiter: nil, token: nil, max: nil,
-                  versions: nil
+                  versions: nil, match_glob: nil
           ensure_service!
           gapi = service.list_files name, prefix: prefix, delimiter: delimiter,
                                           token: token, max: max,
                                           versions: versions,
-                                          user_project: user_project
+                                          user_project: user_project,
+                                          match_glob: match_glob
           File::List.from_gapi gapi, service, name, prefix, delimiter, max,
-                               versions, user_project: user_project
+                               versions,
+                               user_project: user_project,
+                               match_glob: match_glob
         end
         alias find_files files
 

data/lib/google/cloud/storage/file/list.rb

@@ -83,10 +83,12 @@ module Google
                                                 token: @token,
                                                 max: @max,
                                                 versions: @versions,
-                                                user_project: @user_project
+                                                user_project: @user_project,
+                                                match_glob: @match_glob
             File::List.from_gapi gapi, @service, @bucket, @prefix,
                                  @delimiter, @max, @versions,
-                                 user_project: @user_project
+                                 user_project: @user_project,
+                                 match_glob: @match_glob
           end
 
           ##
@@ -163,7 +165,8 @@ module Google
           # Google::Apis::StorageV1::Objects object.
           def self.from_gapi gapi_list, service, bucket = nil, prefix = nil,
                              delimiter = nil, max = nil, versions = nil,
-                             user_project: nil
+                             user_project: nil,
+                             match_glob: nil
             files = new(Array(gapi_list.items).map do |gapi_object|
               File.from_gapi gapi_object, service, user_project: user_project
             end)
@@ -176,6 +179,7 @@ module Google
             files.instance_variable_set :@max, max
             files.instance_variable_set :@versions, versions
             files.instance_variable_set :@user_project, user_project
+            files.instance_variable_set :@match_glob, match_glob
             files
           end
 

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

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
@@ -348,6 +349,7 @@ module Google
         # Retrieves a list of files matching the criteria.
         def list_files bucket_name, delimiter: nil, max: nil, token: nil,
                        prefix: nil, versions: nil, user_project: nil,
+                       match_glob: nil,
                        options: {}
           execute do
             service.list_objects \
@@ -355,6 +357,7 @@ module Google
                            page_token: token, prefix: prefix,
                            versions: versions,
                            user_project: user_project(user_project),
+                           match_glob: match_glob,
                            options: options
           end
         end
@@ -794,6 +797,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.44.0".freeze
+      VERSION = "1.46.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.44.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2024-01-08 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
@@ -325,14 +325,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Storage