google-apis-alloydb_v1 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84355936c244b5b1b3855caf7da54a4f9e73119e70b205d72c8981afa5c0be47
-  data.tar.gz: e59aa0897bff6ecfb9c662a70b3d4b17ee3cb176970058018c724654b3453bde
+  metadata.gz: f13423a0a7dcb498a037d1524f2e9551b922f5b41f82644fc36d167e8e713f67
+  data.tar.gz: ac642aa9b03d8b115aaa82f218b1568e3ba620a4ac6eda28577196f7f777e18e
 SHA512:
-  metadata.gz: 7e1403b003f06f1a749f861b053ac62779cbbf932225f91e60d7952b271d74ded45dbcf2729981fb63551cf4436c32e6d6e7b43930744269f0bef892b2fd5544
-  data.tar.gz: 9999152da0d421dd0e350d5b15c84dffc1ca7262a59fee229d75f8b1a0df63d442f27d2059f640142c29118e2998b1fae5b7be136b87222688c7d9b75f428f9e
+  metadata.gz: b7593cc450c77fdf47258f96e25861751e1bd9b4e94cb126683f247759fb990ac4b8f76dca0d87dd391efdc78a2b140afd40789ba042b0e675e2a3e467dc67af
+  data.tar.gz: a5d7f331b1fce156bd2b652435f8bd01d136085580f6e6fba3bafed3b67514e000e201ea33045afd874ebe3df7ec217c33f16511a27938f6e487ff7dd1a21f7f

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-alloydb_v1
 
+### v0.28.0 (2024-12-15)
+
+* Regenerated from discovery document revision 20241204
+
+### v0.27.0 (2024-11-24)
+
+* Regenerated from discovery document revision 20241106
+
 ### v0.26.0 (2024-11-03)
 
 * Regenerated from discovery document revision 20241023

data/lib/google/apis/alloydb_v1/classes.rb

@@ -837,6 +837,49 @@ module Google
         end
       end
       
+      # Options for exporting data in CSV format.
+      class CsvExportOptions
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Specifies the character that should appear before a data character
+        # that needs to be escaped. The default is the same as quote character. The
+        # value of this argument has to be a character in Hex ASCII Code.
+        # Corresponds to the JSON property `escapeCharacter`
+        # @return [String]
+        attr_accessor :escape_character
+      
+        # Optional. Specifies the character that separates columns within each row (line)
+        # of the file. The default is comma. The value of this argument has to be a
+        # character in Hex ASCII Code.
+        # Corresponds to the JSON property `fieldDelimiter`
+        # @return [String]
+        attr_accessor :field_delimiter
+      
+        # Optional. Specifies the quoting character to be used when a data value is
+        # quoted. The default is double-quote. The value of this argument has to be a
+        # character in Hex ASCII Code.
+        # Corresponds to the JSON property `quoteCharacter`
+        # @return [String]
+        attr_accessor :quote_character
+      
+        # Required. The SELECT query used to extract the data.
+        # Corresponds to the JSON property `selectQuery`
+        # @return [String]
+        attr_accessor :select_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @escape_character = args[:escape_character] if args.key?(:escape_character)
+          @field_delimiter = args[:field_delimiter] if args.key?(:field_delimiter)
+          @quote_character = args[:quote_character] if args.key?(:quote_character)
+          @select_query = args[:select_query] if args.key?(:select_query)
+        end
+      end
+      
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -901,6 +944,64 @@ module Google
         end
       end
       
+      # Export cluster request.
+      class ExportClusterRequest
+        include Google::Apis::Core::Hashable
+      
+        # Options for exporting data in CSV format.
+        # Corresponds to the JSON property `csvExportOptions`
+        # @return [Google::Apis::AlloydbV1::CsvExportOptions]
+        attr_accessor :csv_export_options
+      
+        # Required. Name of the database where the export command will be executed. Note
+        # - Value provided should be the same as expected from `SELECT current_database()
+        # ;` and NOT as a resource reference.
+        # Corresponds to the JSON property `database`
+        # @return [String]
+        attr_accessor :database
+      
+        # Destination for Export. Export will be done to cloud storage.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::AlloydbV1::GcsDestination]
+        attr_accessor :gcs_destination
+      
+        # Options for exporting data in SQL format.
+        # Corresponds to the JSON property `sqlExportOptions`
+        # @return [Google::Apis::AlloydbV1::SqlExportOptions]
+        attr_accessor :sql_export_options
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @csv_export_options = args[:csv_export_options] if args.key?(:csv_export_options)
+          @database = args[:database] if args.key?(:database)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+          @sql_export_options = args[:sql_export_options] if args.key?(:sql_export_options)
+        end
+      end
+      
+      # Response of export cluster rpc.
+      class ExportClusterResponse
+        include Google::Apis::Core::Hashable
+      
+        # Destination for Export. Export will be done to cloud storage.
+        # Corresponds to the JSON property `gcsDestination`
+        # @return [Google::Apis::AlloydbV1::GcsDestination]
+        attr_accessor :gcs_destination
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
+        end
+      end
+      
       # Message for triggering failover on an Instance
       class FailoverInstanceRequest
         include Google::Apis::Core::Hashable
@@ -938,6 +1039,26 @@ module Google
         end
       end
       
+      # Destination for Export. Export will be done to cloud storage.
+      class GcsDestination
+        include Google::Apis::Core::Hashable
+      
+        # Required. The path to the file in Google Cloud Storage where the export will
+        # be stored. The URI is in the form `gs://bucketName/fileName`.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @uri = args[:uri] if args.key?(:uri)
+        end
+      end
+      
       # The response message for Locations.ListLocations.
       class GoogleCloudLocationListLocationsResponse
         include Google::Apis::Core::Hashable
@@ -1856,9 +1977,9 @@ module Google
         attr_accessor :end_time
       
         # Output only. Identifies whether the user has requested cancellation of the
-        # operation. Operations that have successfully been cancelled have Operation.
-        # error value with a google.rpc.Status.code of 1, corresponding to `Code.
-        # CANCELLED`.
+        # operation. Operations that have successfully been cancelled have google.
+        # longrunning.Operation.error value with a google.rpc.Status.code of 1,
+        # corresponding to `Code.CANCELLED`.
         # Corresponds to the JSON property `requestedCancellation`
         # @return [Boolean]
         attr_accessor :requested_cancellation
@@ -2262,6 +2383,48 @@ module Google
         end
       end
       
+      # Options for exporting data in SQL format.
+      class SqlExportOptions
+        include Google::Apis::Core::Hashable
+      
+        # Optional. If true, output commands to DROP all the dumped database objects
+        # prior to outputting the commands for creating them.
+        # Corresponds to the JSON property `cleanTargetObjects`
+        # @return [Boolean]
+        attr_accessor :clean_target_objects
+        alias_method :clean_target_objects?, :clean_target_objects
+      
+        # Optional. If true, use DROP ... IF EXISTS commands to check for the object's
+        # existence before dropping it in clean_target_objects mode.
+        # Corresponds to the JSON property `ifExistTargetObjects`
+        # @return [Boolean]
+        attr_accessor :if_exist_target_objects
+        alias_method :if_exist_target_objects?, :if_exist_target_objects
+      
+        # Optional. If true, only export the schema.
+        # Corresponds to the JSON property `schemaOnly`
+        # @return [Boolean]
+        attr_accessor :schema_only
+        alias_method :schema_only?, :schema_only
+      
+        # Optional. Tables to export from.
+        # Corresponds to the JSON property `tables`
+        # @return [Array<String>]
+        attr_accessor :tables
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @clean_target_objects = args[:clean_target_objects] if args.key?(:clean_target_objects)
+          @if_exist_target_objects = args[:if_exist_target_objects] if args.key?(:if_exist_target_objects)
+          @schema_only = args[:schema_only] if args.key?(:schema_only)
+          @tables = args[:tables] if args.key?(:tables)
+        end
+      end
+      
       # SSL configuration.
       class SslConfig
         include Google::Apis::Core::Hashable
@@ -3068,6 +3231,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :shard_count
       
+        # Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto
+        # validations again after bug fix.
+        # Corresponds to the JSON property `vcpuCount`
+        # @return [Float]
+        attr_accessor :vcpu_count
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3077,6 +3246,7 @@ module Google
           @cpu_count = args[:cpu_count] if args.key?(:cpu_count)
           @memory_size_in_bytes = args[:memory_size_in_bytes] if args.key?(:memory_size_in_bytes)
           @shard_count = args[:shard_count] if args.key?(:shard_count)
+          @vcpu_count = args[:vcpu_count] if args.key?(:vcpu_count)
         end
       end
       

data/lib/google/apis/alloydb_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module AlloydbV1
       # Version of the google-apis-alloydb_v1 gem
-      GEM_VERSION = "0.26.0"
+      GEM_VERSION = "0.28.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20241023"
+      REVISION = "20241204"
     end
   end
 end

data/lib/google/apis/alloydb_v1/representations.rb

@@ -100,6 +100,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CsvExportOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Empty
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -118,12 +124,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExportClusterRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ExportClusterResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class FailoverInstanceRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GcsDestination
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudLocationListLocationsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -328,6 +352,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class SqlExportOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class SslConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -722,6 +752,16 @@ module Google
         end
       end
       
+      class CsvExportOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :escape_character, as: 'escapeCharacter'
+          property :field_delimiter, as: 'fieldDelimiter'
+          property :quote_character, as: 'quoteCharacter'
+          property :select_query, as: 'selectQuery'
+        end
+      end
+      
       class Empty
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -743,6 +783,27 @@ module Google
         end
       end
       
+      class ExportClusterRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :csv_export_options, as: 'csvExportOptions', class: Google::Apis::AlloydbV1::CsvExportOptions, decorator: Google::Apis::AlloydbV1::CsvExportOptions::Representation
+      
+          property :database, as: 'database'
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::AlloydbV1::GcsDestination, decorator: Google::Apis::AlloydbV1::GcsDestination::Representation
+      
+          property :sql_export_options, as: 'sqlExportOptions', class: Google::Apis::AlloydbV1::SqlExportOptions, decorator: Google::Apis::AlloydbV1::SqlExportOptions::Representation
+      
+        end
+      end
+      
+      class ExportClusterResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :gcs_destination, as: 'gcsDestination', class: Google::Apis::AlloydbV1::GcsDestination, decorator: Google::Apis::AlloydbV1::GcsDestination::Representation
+      
+        end
+      end
+      
       class FailoverInstanceRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -751,6 +812,13 @@ module Google
         end
       end
       
+      class GcsDestination
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :uri, as: 'uri'
+        end
+      end
+      
       class GoogleCloudLocationListLocationsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1094,6 +1162,16 @@ module Google
         end
       end
       
+      class SqlExportOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :clean_target_objects, as: 'cleanTargetObjects'
+          property :if_exist_target_objects, as: 'ifExistTargetObjects'
+          property :schema_only, as: 'schemaOnly'
+          collection :tables, as: 'tables'
+        end
+      end
+      
       class SslConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1298,6 +1376,7 @@ module Google
           property :cpu_count, as: 'cpuCount'
           property :memory_size_in_bytes, :numeric_string => true, as: 'memorySizeInBytes'
           property :shard_count, as: 'shardCount'
+          property :vcpu_count, as: 'vcpuCount'
         end
       end
       

data/lib/google/apis/alloydb_v1/service.rb

@@ -542,6 +542,39 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Exports data from the cluster. Imperative only.
+        # @param [String] name
+        #   Required. The resource name of the cluster.
+        # @param [Google::Apis::AlloydbV1::ExportClusterRequest] export_cluster_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::AlloydbV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::AlloydbV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def export_cluster(name, export_cluster_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:export', options)
+          command.request_representation = Google::Apis::AlloydbV1::ExportClusterRequest::Representation
+          command.request_object = export_cluster_request_object
+          command.response_representation = Google::Apis::AlloydbV1::Operation::Representation
+          command.response_class = Google::Apis::AlloydbV1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets details of a single Cluster.
         # @param [String] name
         #   Required. The name of the resource. For the required format, see the comment
@@ -1524,8 +1557,8 @@ module Google
         # Clients can use Operations.GetOperation or other methods to check whether the
         # cancellation succeeded or whether the operation completed despite cancellation.
         # On successful cancellation, the operation is not deleted; instead, it becomes
-        # an operation with an Operation.error value with a google.rpc.Status.code of 1,
-        # corresponding to `Code.CANCELLED`.
+        # an operation with an Operation.error value with a google.rpc.Status.code of `1`
+        # , corresponding to `Code.CANCELLED`.
         # @param [String] name
         #   The name of the operation resource to be cancelled.
         # @param [Google::Apis::AlloydbV1::CancelOperationRequest] cancel_operation_request_object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-alloydb_v1
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-03 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-alloydb_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-alloydb_v1/v0.26.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-alloydb_v1/v0.28.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-alloydb_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Simple REST client for AlloyDB API V1