google-cloud-spanner 0.21.0

data/lib/google/cloud/spanner/admin/database/v1/database_admin_client_config.json

@@ -0,0 +1,73 @@
+{
+  "interfaces": {
+    "google.spanner.admin.database.v1.DatabaseAdmin": {
+      "retry_codes": {
+        "idempotent": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ],
+        "non_idempotent": [
+          "UNAVAILABLE"
+        ]
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 1000,
+          "retry_delay_multiplier": 1.3,
+          "max_retry_delay_millis": 32000,
+          "initial_rpc_timeout_millis": 60000,
+          "rpc_timeout_multiplier": 1.0,
+          "max_rpc_timeout_millis": 60000,
+          "total_timeout_millis": 600000
+        }
+      },
+      "methods": {
+        "ListDatabases": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateDatabase": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "GetDatabase": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateDatabaseDdl": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "DropDatabase": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetDatabaseDdl": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "SetIamPolicy": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "GetIamPolicy": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "TestIamPermissions": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb

@@ -0,0 +1,139 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Iam
+    module V1
+      # Defines an Identity and Access Management (IAM) policy. It is used to
+      # specify access control policies for Cloud Platform resources.
+      #
+      #
+      # A +Policy+ consists of a list of +bindings+. A +Binding+ binds a list of
+      # +members+ to a +role+, where the members can be user accounts, Google groups,
+      # Google domains, and service accounts. A +role+ is a named list of permissions
+      # defined by IAM.
+      #
+      # **Example**
+      #
+      #     {
+      #       "bindings": [
+      #         {
+      #           "role": "roles/owner",
+      #           "members": [
+      #             "user:mike@example.com",
+      #             "group:admins@example.com",
+      #             "domain:google.com",
+      #             "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+      #           ]
+      #         },
+      #         {
+      #           "role": "roles/viewer",
+      #           "members": ["user:sean@example.com"]
+      #         }
+      #       ]
+      #     }
+      #
+      # For a description of IAM and its features, see the
+      # {IAM developer's guide}[https://cloud.google.com/iam].
+      # @!attribute [rw] version
+      #   @return [Integer]
+      #     Version of the +Policy+. The default version is 0.
+      # @!attribute [rw] bindings
+      #   @return [Array<Google::Iam::V1::Binding>]
+      #     Associates a list of +members+ to a +role+.
+      #     Multiple +bindings+ must not be specified for the same +role+.
+      #     +bindings+ with no members will result in an error.
+      # @!attribute [rw] etag
+      #   @return [String]
+      #     +etag+ is used for optimistic concurrency control as a way to help
+      #     prevent simultaneous updates of a policy from overwriting each other.
+      #     It is strongly suggested that systems make use of the +etag+ in the
+      #     read-modify-write cycle to perform policy updates in order to avoid race
+      #     conditions: An +etag+ is returned in the response to +getIamPolicy+, and
+      #     systems are expected to put that etag in the request to +setIamPolicy+ to
+      #     ensure that their change will be applied to the same version of the policy.
+      #
+      #     If no +etag+ is provided in the call to +setIamPolicy+, then the existing
+      #     policy is overwritten blindly.
+      class Policy; end
+
+      # Associates +members+ with a +role+.
+      # @!attribute [rw] role
+      #   @return [String]
+      #     Role that is assigned to +members+.
+      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Required
+      # @!attribute [rw] members
+      #   @return [Array<String>]
+      #     Specifies the identities requesting access for a Cloud Platform resource.
+      #     +members+ can have the following values:
+      #
+      #     * +allUsers+: A special identifier that represents anyone who is
+      #        on the internet; with or without a Google account.
+      #
+      #     * +allAuthenticatedUsers+: A special identifier that represents anyone
+      #        who is authenticated with a Google account or a service account.
+      #
+      #     * +user:{emailid}+: An email address that represents a specific Google
+      #        account. For example, +alice@gmail.com+ or +joe@example.com+.
+      #
+      #
+      #     * +serviceAccount:{emailid}+: An email address that represents a service
+      #        account. For example, +my-other-app@appspot.gserviceaccount.com+.
+      #
+      #     * +group:{emailid}+: An email address that represents a Google group.
+      #        For example, +admins@example.com+.
+      #
+      #     * +domain:{domain}+: A Google Apps domain name that represents all the
+      #        users of that domain. For example, +google.com+ or +example.com+.
+      class Binding; end
+
+      # The difference delta between two policies.
+      # @!attribute [rw] binding_deltas
+      #   @return [Array<Google::Iam::V1::BindingDelta>]
+      #     The delta for Bindings between two policies.
+      class PolicyDelta; end
+
+      # One delta entry for Binding. Each individual change (only one member in each
+      # entry) to a binding will be a separate entry.
+      # @!attribute [rw] action
+      #   @return [Google::Iam::V1::BindingDelta::Action]
+      #     The action that was performed on a Binding.
+      #     Required
+      # @!attribute [rw] role
+      #   @return [String]
+      #     Role that is assigned to +members+.
+      #     For example, +roles/viewer+, +roles/editor+, or +roles/owner+.
+      #     Required
+      # @!attribute [rw] member
+      #   @return [String]
+      #     A single identity requesting access for a Cloud Platform resource.
+      #     Follows the same format of Binding.members.
+      #     Required
+      class BindingDelta
+        # The type of action performed on a Binding in a policy.
+        module Action
+          # Unspecified.
+          ACTION_UNSPECIFIED = 0
+
+          # Addition of a Binding.
+          ADD = 1
+
+          # Removal of a Binding.
+          REMOVE = 2
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb

@@ -0,0 +1,114 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message Google::Protobuf::Duration):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a Google::Protobuf::Type
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb

@@ -0,0 +1,83 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Rpc
+    # The +Status+ type defines a logical error model that is suitable for different
+    # programming environments, including REST APIs and RPC APIs. It is used by
+    # {gRPC}[https://github.com/grpc]. The error model is designed to be:
+    #
+    # - Simple to use and understand for most users
+    # - Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The +Status+ message contains three pieces of data: error code, error message,
+    # and error details. The error code should be an enum value of
+    # Google::Rpc::Code, but it may accept additional error codes if needed.  The
+    # error message should be a developer-facing English message that helps
+    # developers *understand* and *resolve* the error. If a localized user-facing
+    # error message is needed, put the localized message in the error details or
+    # localize it in the client. The optional error details may contain arbitrary
+    # information about the error. There is a predefined set of error detail types
+    # in the package +google.rpc+ which can be used for common error conditions.
+    #
+    # = Language mapping
+    #
+    # The +Status+ message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the +Status+ message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the +Status+ message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # - Partial errors. If a service needs to return partial errors to the client,
+    #     it may embed the +Status+ in the normal response to indicate the partial
+    #     errors.
+    #
+    # - Workflow errors. A typical workflow has multiple steps. Each step may
+    #     have a +Status+ message for error reporting purpose.
+    #
+    # - Batch operations. If a client uses batch request and batch response, the
+    #     +Status+ message should be used directly inside batch response, one for
+    #     each error sub-response.
+    #
+    # - Asynchronous operations. If an API call embeds asynchronous operation
+    #     results in its response, the status of those operations should be
+    #     represented directly using the +Status+ message.
+    #
+    # - Logging. If some API errors are stored in logs, the message +Status+ could
+    #     be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of Google::Rpc::Code.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     Google::Rpc::Status#details field, or localized by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There will be a
+    #     common set of message types for APIs to use.
+    class Status; end
+  end
+end

data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb

@@ -0,0 +1,188 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Spanner
+    module Admin
+      module Database
+        module V1
+          # A Cloud Spanner database.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     Required. The name of the database. Values are of the form
+          #     +projects/<project>/instances/<instance>/databases/<database>+,
+          #     where +<database>+ is as specified in the +CREATE DATABASE+
+          #     statement. This name can be passed to other API methods to
+          #     identify the database.
+          # @!attribute [rw] state
+          #   @return [Google::Spanner::Admin::Database::V1::Database::State]
+          #     Output only. The current database state.
+          class Database
+            # Indicates the current state of the database.
+            module State
+              # Not specified.
+              STATE_UNSPECIFIED = 0
+
+              # The database is still being created. Operations on the database may fail
+              # with +FAILED_PRECONDITION+ in this state.
+              CREATING = 1
+
+              # The database is fully created and ready for use.
+              READY = 2
+            end
+          end
+
+          # The request for ListDatabases.
+          # @!attribute [rw] parent
+          #   @return [String]
+          #     Required. The instance whose databases should be listed.
+          #     Values are of the form +projects/<project>/instances/<instance>+.
+          # @!attribute [rw] page_size
+          #   @return [Integer]
+          #     Number of databases to be returned in the response. If 0 or less,
+          #     defaults to the server's maximum allowed page size.
+          # @!attribute [rw] page_token
+          #   @return [String]
+          #     If non-empty, +page_token+ should contain a
+          #     Next_page_token from a
+          #     previous ListDatabasesResponse.
+          class ListDatabasesRequest; end
+
+          # The response for ListDatabases.
+          # @!attribute [rw] databases
+          #   @return [Array<Google::Spanner::Admin::Database::V1::Database>]
+          #     Databases that matched the request.
+          # @!attribute [rw] next_page_token
+          #   @return [String]
+          #     +next_page_token+ can be sent in a subsequent
+          #     ListDatabases call to fetch more
+          #     of the matching databases.
+          class ListDatabasesResponse; end
+
+          # The request for CreateDatabase.
+          # @!attribute [rw] parent
+          #   @return [String]
+          #     Required. The name of the instance that will serve the new database.
+          #     Values are of the form +projects/<project>/instances/<instance>+.
+          # @!attribute [rw] create_statement
+          #   @return [String]
+          #     Required. A +CREATE DATABASE+ statement, which specifies the ID of the
+          #     new database.  The database ID must conform to the regular expression
+          #     +[a-z][a-z0-9_\-]*[a-z0-9]+ and be between 2 and 30 characters in length.
+          # @!attribute [rw] extra_statements
+          #   @return [Array<String>]
+          #     An optional list of DDL statements to run inside the newly created
+          #     database. Statements can create tables, indexes, etc. These
+          #     statements execute atomically with the creation of the database:
+          #     if there is an error in any statement, the database is not created.
+          class CreateDatabaseRequest; end
+
+          # Metadata type for the operation returned by
+          # CreateDatabase.
+          # @!attribute [rw] database
+          #   @return [String]
+          #     The database being created.
+          class CreateDatabaseMetadata; end
+
+          # The request for GetDatabase.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     Required. The name of the requested database. Values are of the form
+          #     +projects/<project>/instances/<instance>/databases/<database>+.
+          class GetDatabaseRequest; end
+
+          # Enqueues the given DDL statements to be applied, in order but not
+          # necessarily all at once, to the database schema at some point (or
+          # points) in the future. The server checks that the statements
+          # are executable (syntactically valid, name tables that exist, etc.)
+          # before enqueueing them, but they may still fail upon
+          # later execution (e.g., if a statement from another batch of
+          # statements is applied first and it conflicts in some way, or if
+          # there is some data-related problem like a +NULL+ value in a column to
+          # which +NOT NULL+ would be added). If a statement fails, all
+          # subsequent statements in the batch are automatically cancelled.
+          #
+          # Each batch of statements is assigned a name which can be used with
+          # the Operations API to monitor
+          # progress. See the
+          # Operation_id field for more
+          # details.
+          # @!attribute [rw] database
+          #   @return [String]
+          #     Required. The database to update.
+          # @!attribute [rw] statements
+          #   @return [Array<String>]
+          #     DDL statements to be applied to the database.
+          # @!attribute [rw] operation_id
+          #   @return [String]
+          #     If empty, the new update request is assigned an
+          #     automatically-generated operation ID. Otherwise, +operation_id+
+          #     is used to construct the name of the resulting
+          #     Operation.
+          #
+          #     Specifying an explicit operation ID simplifies determining
+          #     whether the statements were executed in the event that the
+          #     UpdateDatabaseDdl call is replayed,
+          #     or the return value is otherwise lost: the Database and
+          #     +operation_id+ fields can be combined to form the
+          #     Name of the resulting
+          #     Longrunning::Operation: +<database>/operations/<operation_id>+.
+          #
+          #     +operation_id+ should be unique within the database, and must be
+          #     a valid identifier: +[a-z][a-z0-9_]*+. Note that
+          #     automatically-generated operation IDs always begin with an
+          #     underscore. If the named operation already exists,
+          #     UpdateDatabaseDdl returns
+          #     +ALREADY_EXISTS+.
+          class UpdateDatabaseDdlRequest; end
+
+          # Metadata type for the operation returned by
+          # UpdateDatabaseDdl.
+          # @!attribute [rw] database
+          #   @return [String]
+          #     The database being modified.
+          # @!attribute [rw] statements
+          #   @return [Array<String>]
+          #     For an update this list contains all the statements. For an
+          #     individual statement, this list contains only that statement.
+          # @!attribute [rw] commit_timestamps
+          #   @return [Array<Google::Protobuf::Timestamp>]
+          #     Reports the commit timestamps of all statements that have
+          #     succeeded so far, where +commit_timestamps[i]+ is the commit
+          #     timestamp for the statement +statements[i]+.
+          class UpdateDatabaseDdlMetadata; end
+
+          # The request for DropDatabase.
+          # @!attribute [rw] database
+          #   @return [String]
+          #     Required. The database to be dropped.
+          class DropDatabaseRequest; end
+
+          # The request for GetDatabaseDdl.
+          # @!attribute [rw] database
+          #   @return [String]
+          #     Required. The database whose schema we wish to get.
+          class GetDatabaseDdlRequest; end
+
+          # The response for GetDatabaseDdl.
+          # @!attribute [rw] statements
+          #   @return [Array<String>]
+          #     A list of formatted DDL statements defining the schema of the database
+          #     specified in the request.
+          class GetDatabaseDdlResponse; end
+        end
+      end
+    end
+  end
+end