google-cloud-bigtable-admin-v2 0.2.0 → 0.5.1

data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb

@@ -63,6 +63,27 @@ module Google
                 "projects/#{project}/instances/#{instance}/clusters/#{cluster}"
               end
 
+              ##
+              # Create a fully-qualified CryptoKey resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`
+              #
+              # @param project [String]
+              # @param location [String]
+              # @param key_ring [String]
+              # @param crypto_key [String]
+              #
+              # @return [::String]
+              def crypto_key_path project:, location:, key_ring:, crypto_key:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                raise ::ArgumentError, "key_ring cannot contain /" if key_ring.to_s.include? "/"
+
+                "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}"
+              end
+
               ##
               # Create a fully-qualified Instance resource string.
               #

data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb

@@ -65,29 +65,27 @@ module Google
                   parent_config = while namespace.any?
                                     parent_name = namespace.join "::"
                                     parent_const = const_get parent_name
-                                    break parent_const.configure if parent_const&.respond_to? :configure
+                                    break parent_const.configure if parent_const.respond_to? :configure
                                     namespace.pop
                                   end
                   default_config = Client::Configuration.new parent_config
 
                   default_config.rpcs.create_table.timeout = 300.0
 
-                  default_config.rpcs.create_table_from_snapshot.timeout = 60.0
-
                   default_config.rpcs.list_tables.timeout = 60.0
                   default_config.rpcs.list_tables.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.get_table.timeout = 60.0
                   default_config.rpcs.get_table.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.delete_table.timeout = 60.0
@@ -99,45 +97,67 @@ module Google
                   default_config.rpcs.generate_consistency_token.timeout = 60.0
                   default_config.rpcs.generate_consistency_token.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.check_consistency.timeout = 60.0
                   default_config.rpcs.check_consistency.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
-                  default_config.rpcs.snapshot_table.timeout = 60.0
-
                   default_config.rpcs.get_snapshot.timeout = 60.0
                   default_config.rpcs.get_snapshot.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.list_snapshots.timeout = 60.0
                   default_config.rpcs.list_snapshots.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.delete_snapshot.timeout = 60.0
 
+                  default_config.rpcs.create_backup.timeout = 60.0
+
+                  default_config.rpcs.get_backup.timeout = 60.0
+                  default_config.rpcs.get_backup.retry_policy = {
+                    initial_delay: 1.0,
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.update_backup.timeout = 60.0
+
+                  default_config.rpcs.delete_backup.timeout = 60.0
+
+                  default_config.rpcs.list_backups.timeout = 60.0
+                  default_config.rpcs.list_backups.retry_policy = {
+                    initial_delay: 1.0,
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
+                  }
+
+                  default_config.rpcs.restore_table.timeout = 60.0
+
                   default_config.rpcs.get_iam_policy.timeout = 60.0
                   default_config.rpcs.get_iam_policy.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config.rpcs.set_iam_policy.timeout = 60.0
@@ -145,9 +165,9 @@ module Google
                   default_config.rpcs.test_iam_permissions.timeout = 60.0
                   default_config.rpcs.test_iam_permissions.retry_policy = {
                     initial_delay: 1.0,
-                    max_delay:     60.0,
-                    multiplier:    2,
-                    retry_codes:   [14, 4]
+                    max_delay: 60.0,
+                    multiplier: 2,
+                    retry_codes: [14, 4]
                   }
 
                   default_config
@@ -211,7 +231,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
@@ -1685,7 +1711,7 @@ module Google
 
               ##
               # Create a new table by restoring from a completed backup. The new table
-              # must be in the same instance as the instance containing the backup.  The
+              # must be in the same project as the instance containing the backup.  The
               # returned table {::Google::Longrunning::Operation long-running operation} can
               # be used to track the progress of the operation, and to cancel it.  The
               # {::Google::Longrunning::Operation#metadata metadata} field type is
@@ -1710,8 +1736,8 @@ module Google
               #
               #   @param parent [::String]
               #     Required. The name of the instance in which to create the restored
-              #     table. This instance must be the parent of the source backup. Values are
-              #     of the form `projects/<project>/instances/<instance>`.
+              #     table. This instance must be in the same project as the source backup.
+              #     Values are of the form `projects/<project>/instances/<instance>`.
               #   @param table_id [::String]
               #     Required. The id of the table to create and restore to. This
               #     table must not already exist. The `table_id` appended to
@@ -2076,7 +2102,7 @@ module Google
                 config_attr :scope,         nil, ::String, ::Array, nil
                 config_attr :lib_name,      nil, ::String, nil
                 config_attr :lib_version,   nil, ::String, nil
-                config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
                 config_attr :interceptors,  nil, ::Array, nil
                 config_attr :timeout,       nil, ::Numeric, nil
                 config_attr :metadata,      nil, ::Hash, nil
@@ -2097,7 +2123,7 @@ module Google
                 def rpcs
                   @rpcs ||= begin
                     parent_rpcs = nil
-                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                     Rpcs.new parent_rpcs
                   end
                 end
@@ -2109,7 +2135,7 @@ module Google
                 # Each configuration object is of type `Gapic::Config::Method` and includes
                 # the following configuration fields:
                 #
-                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                 #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                 #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                 #     include the following keys:
@@ -2233,49 +2259,49 @@ module Google
 
                   # @private
                   def initialize parent_rpcs = nil
-                    create_table_config = parent_rpcs&.create_table if parent_rpcs&.respond_to? :create_table
+                    create_table_config = parent_rpcs.create_table if parent_rpcs.respond_to? :create_table
                     @create_table = ::Gapic::Config::Method.new create_table_config
-                    create_table_from_snapshot_config = parent_rpcs&.create_table_from_snapshot if parent_rpcs&.respond_to? :create_table_from_snapshot
+                    create_table_from_snapshot_config = parent_rpcs.create_table_from_snapshot if parent_rpcs.respond_to? :create_table_from_snapshot
                     @create_table_from_snapshot = ::Gapic::Config::Method.new create_table_from_snapshot_config
-                    list_tables_config = parent_rpcs&.list_tables if parent_rpcs&.respond_to? :list_tables
+                    list_tables_config = parent_rpcs.list_tables if parent_rpcs.respond_to? :list_tables
                     @list_tables = ::Gapic::Config::Method.new list_tables_config
-                    get_table_config = parent_rpcs&.get_table if parent_rpcs&.respond_to? :get_table
+                    get_table_config = parent_rpcs.get_table if parent_rpcs.respond_to? :get_table
                     @get_table = ::Gapic::Config::Method.new get_table_config
-                    delete_table_config = parent_rpcs&.delete_table if parent_rpcs&.respond_to? :delete_table
+                    delete_table_config = parent_rpcs.delete_table if parent_rpcs.respond_to? :delete_table
                     @delete_table = ::Gapic::Config::Method.new delete_table_config
-                    modify_column_families_config = parent_rpcs&.modify_column_families if parent_rpcs&.respond_to? :modify_column_families
+                    modify_column_families_config = parent_rpcs.modify_column_families if parent_rpcs.respond_to? :modify_column_families
                     @modify_column_families = ::Gapic::Config::Method.new modify_column_families_config
-                    drop_row_range_config = parent_rpcs&.drop_row_range if parent_rpcs&.respond_to? :drop_row_range
+                    drop_row_range_config = parent_rpcs.drop_row_range if parent_rpcs.respond_to? :drop_row_range
                     @drop_row_range = ::Gapic::Config::Method.new drop_row_range_config
-                    generate_consistency_token_config = parent_rpcs&.generate_consistency_token if parent_rpcs&.respond_to? :generate_consistency_token
+                    generate_consistency_token_config = parent_rpcs.generate_consistency_token if parent_rpcs.respond_to? :generate_consistency_token
                     @generate_consistency_token = ::Gapic::Config::Method.new generate_consistency_token_config
-                    check_consistency_config = parent_rpcs&.check_consistency if parent_rpcs&.respond_to? :check_consistency
+                    check_consistency_config = parent_rpcs.check_consistency if parent_rpcs.respond_to? :check_consistency
                     @check_consistency = ::Gapic::Config::Method.new check_consistency_config
-                    snapshot_table_config = parent_rpcs&.snapshot_table if parent_rpcs&.respond_to? :snapshot_table
+                    snapshot_table_config = parent_rpcs.snapshot_table if parent_rpcs.respond_to? :snapshot_table
                     @snapshot_table = ::Gapic::Config::Method.new snapshot_table_config
-                    get_snapshot_config = parent_rpcs&.get_snapshot if parent_rpcs&.respond_to? :get_snapshot
+                    get_snapshot_config = parent_rpcs.get_snapshot if parent_rpcs.respond_to? :get_snapshot
                     @get_snapshot = ::Gapic::Config::Method.new get_snapshot_config
-                    list_snapshots_config = parent_rpcs&.list_snapshots if parent_rpcs&.respond_to? :list_snapshots
+                    list_snapshots_config = parent_rpcs.list_snapshots if parent_rpcs.respond_to? :list_snapshots
                     @list_snapshots = ::Gapic::Config::Method.new list_snapshots_config
-                    delete_snapshot_config = parent_rpcs&.delete_snapshot if parent_rpcs&.respond_to? :delete_snapshot
+                    delete_snapshot_config = parent_rpcs.delete_snapshot if parent_rpcs.respond_to? :delete_snapshot
                     @delete_snapshot = ::Gapic::Config::Method.new delete_snapshot_config
-                    create_backup_config = parent_rpcs&.create_backup if parent_rpcs&.respond_to? :create_backup
+                    create_backup_config = parent_rpcs.create_backup if parent_rpcs.respond_to? :create_backup
                     @create_backup = ::Gapic::Config::Method.new create_backup_config
-                    get_backup_config = parent_rpcs&.get_backup if parent_rpcs&.respond_to? :get_backup
+                    get_backup_config = parent_rpcs.get_backup if parent_rpcs.respond_to? :get_backup
                     @get_backup = ::Gapic::Config::Method.new get_backup_config
-                    update_backup_config = parent_rpcs&.update_backup if parent_rpcs&.respond_to? :update_backup
+                    update_backup_config = parent_rpcs.update_backup if parent_rpcs.respond_to? :update_backup
                     @update_backup = ::Gapic::Config::Method.new update_backup_config
-                    delete_backup_config = parent_rpcs&.delete_backup if parent_rpcs&.respond_to? :delete_backup
+                    delete_backup_config = parent_rpcs.delete_backup if parent_rpcs.respond_to? :delete_backup
                     @delete_backup = ::Gapic::Config::Method.new delete_backup_config
-                    list_backups_config = parent_rpcs&.list_backups if parent_rpcs&.respond_to? :list_backups
+                    list_backups_config = parent_rpcs.list_backups if parent_rpcs.respond_to? :list_backups
                     @list_backups = ::Gapic::Config::Method.new list_backups_config
-                    restore_table_config = parent_rpcs&.restore_table if parent_rpcs&.respond_to? :restore_table
+                    restore_table_config = parent_rpcs.restore_table if parent_rpcs.respond_to? :restore_table
                     @restore_table = ::Gapic::Config::Method.new restore_table_config
-                    get_iam_policy_config = parent_rpcs&.get_iam_policy if parent_rpcs&.respond_to? :get_iam_policy
+                    get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
                     @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
-                    set_iam_policy_config = parent_rpcs&.set_iam_policy if parent_rpcs&.respond_to? :set_iam_policy
+                    set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
                     @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
-                    test_iam_permissions_config = parent_rpcs&.test_iam_permissions if parent_rpcs&.respond_to? :test_iam_permissions
+                    test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
                     @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
 
                     yield self if block_given?

data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb

@@ -104,8 +104,13 @@ module Google
               # Lists operations that match the specified filter in the request. If the
               # server doesn't support this method, it returns `UNIMPLEMENTED`.
               #
-              # NOTE: the `name` binding below allows API services to override the binding
-              # to use different resource name schemes, such as `users/*/operations`.
+              # NOTE: the `name` binding allows API services to override the binding
+              # to use different resource name schemes, such as `users/*/operations`. To
+              # override the binding, API services can add a binding such as
+              # `"/v1/{name=users/*}/operations"` to their service configuration.
+              # For backwards compatibility, the default name includes the operations
+              # collection id, however overriding users must ensure the name binding
+              # is the parent resource, without the operations collection id.
               #
               # @overload list_operations(request, options = nil)
               #   Pass arguments to `list_operations` via a request object, either of type
@@ -123,7 +128,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     The name of the operation collection.
+              #     The name of the operation's parent resource.
               #   @param filter [::String]
               #     The standard list filter.
               #   @param page_size [::Integer]
@@ -391,6 +396,79 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Waits for the specified long-running operation until it is done or reaches
+              # at most a specified timeout, returning the latest state.  If the operation
+              # is already done, the latest state is immediately returned.  If the timeout
+              # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
+              # timeout is used.  If the server does not support this method, it returns
+              # `google.rpc.Code.UNIMPLEMENTED`.
+              # Note that this method is on a best-effort basis.  It may return the latest
+              # state before the specified timeout (including immediately), meaning even an
+              # immediate response is no guarantee that the operation is done.
+              #
+              # @overload wait_operation(request, options = nil)
+              #   Pass arguments to `wait_operation` via a request object, either of type
+              #   {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload wait_operation(name: nil, timeout: nil)
+              #   Pass arguments to `wait_operation` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     The name of the operation resource to wait on.
+              #   @param timeout [::Google::Protobuf::Duration, ::Hash]
+              #     The maximum duration to wait before timing out. If left blank, the wait
+              #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+              #     If RPC context deadline is also specified, the shorter one will be used.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::Operation]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              def wait_operation request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.wait_operation.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Bigtable::Admin::V2::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.wait_operation.retry_policy
+                options.apply_defaults metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
+                  response = ::Gapic::Operation.new response, @operations_client, options: options
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the Operations API.
               #
@@ -483,7 +561,7 @@ module Google
                 config_attr :scope,         nil, ::String, ::Array, nil
                 config_attr :lib_name,      nil, ::String, nil
                 config_attr :lib_version,   nil, ::String, nil
-                config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+                config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
                 config_attr :interceptors,  nil, ::Array, nil
                 config_attr :timeout,       nil, ::Numeric, nil
                 config_attr :metadata,      nil, ::Hash, nil
@@ -504,7 +582,7 @@ module Google
                 def rpcs
                   @rpcs ||= begin
                     parent_rpcs = nil
-                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
                     Rpcs.new parent_rpcs
                   end
                 end
@@ -516,7 +594,7 @@ module Google
                 # Each configuration object is of type `Gapic::Config::Method` and includes
                 # the following configuration fields:
                 #
-                #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
                 #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
                 #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
                 #     include the following keys:
@@ -547,17 +625,24 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :cancel_operation
+                  ##
+                  # RPC-specific configuration for `wait_operation`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :wait_operation
 
                   # @private
                   def initialize parent_rpcs = nil
-                    list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
+                    list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
                     @list_operations = ::Gapic::Config::Method.new list_operations_config
-                    get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
+                    get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
                     @get_operation = ::Gapic::Config::Method.new get_operation_config
-                    delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
+                    delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
                     @delete_operation = ::Gapic::Config::Method.new delete_operation_config
-                    cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
+                    cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
                     @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
+                    wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
+                    @wait_operation = ::Gapic::Config::Method.new wait_operation_config
 
                     yield self if block_given?
                   end