google-cloud-spanner 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/google-cloud-spanner.rb +13 -10
- data/lib/google/cloud/spanner.rb +21 -18
- data/lib/google/cloud/spanner/admin/database.rb +111 -0
- data/lib/google/cloud/spanner/admin/database/credentials.rb +35 -0
- data/lib/google/cloud/spanner/admin/database/v1.rb +100 -3
- data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb +129 -138
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb +8 -8
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb +12 -2
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb +22 -22
- data/lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb +33 -20
- data/lib/google/cloud/spanner/admin/database/v1/doc/overview.rb +57 -0
- data/lib/google/cloud/spanner/admin/instance.rb +127 -0
- data/lib/google/cloud/spanner/admin/instance/credentials.rb +35 -0
- data/lib/google/cloud/spanner/admin/instance/v1.rb +116 -3
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb +8 -8
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb +12 -2
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb +22 -22
- data/lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb +58 -43
- data/lib/google/cloud/spanner/admin/instance/v1/doc/overview.rb +57 -0
- data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb +180 -189
- data/lib/google/cloud/spanner/client.rb +3 -3
- data/lib/google/cloud/spanner/credentials.rb +33 -7
- data/lib/google/cloud/spanner/database.rb +3 -6
- data/lib/google/cloud/spanner/instance.rb +2 -4
- data/lib/google/cloud/spanner/instance/config.rb +2 -4
- data/lib/google/cloud/spanner/project.rb +6 -6
- data/lib/google/cloud/spanner/service.rb +5 -26
- data/lib/google/cloud/spanner/session.rb +4 -4
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb +14 -1
- data/lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb +26 -1
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb +3 -3
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb +12 -12
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb +9 -9
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb +33 -33
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb +99 -28
- data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb +41 -31
- data/lib/google/cloud/spanner/v1/doc/overview.rb +54 -0
- data/lib/google/cloud/spanner/v1/spanner_client.rb +277 -195
- data/lib/google/cloud/spanner/v1/spanner_client_config.json +5 -0
- data/lib/google/cloud/spanner/version.rb +1 -1
- data/lib/google/spanner/v1/spanner_pb.rb +16 -1
- data/lib/google/spanner/v1/spanner_services_pb.rb +2 -0
- metadata +16 -23
@@ -0,0 +1,35 @@
|
|
1
|
+
# Copyright 2017, Google Inc. All rights reserved.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "googleauth"
|
16
|
+
|
17
|
+
module Google
|
18
|
+
module Cloud
|
19
|
+
module Spanner
|
20
|
+
module Admin
|
21
|
+
module Instance
|
22
|
+
class Credentials < Google::Auth::Credentials
|
23
|
+
SCOPE = [
|
24
|
+
"https://www.googleapis.com/auth/cloud-platform",
|
25
|
+
"https://www.googleapis.com/auth/spanner.admin"
|
26
|
+
].freeze
|
27
|
+
PATH_ENV_VARS = %w(SPANNER_ADMIN_INSTANCE_KEYFILE, GOOGLE_CLOUD_KEYFILE, GCLOUD_KEYFILE)
|
28
|
+
JSON_ENV_VARS = %w(SPANNER_ADMIN_INSTANCE_KEYFILE_JSON, GOOGLE_CLOUD_KEYFILE_JSON, GCLOUD_KEYFILE_JSON)
|
29
|
+
DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -1,5 +1,4 @@
|
|
1
|
-
|
2
|
-
# Copyright 2016 Google Inc. All rights reserved.
|
1
|
+
# Copyright 2017, Google Inc. All rights reserved.
|
3
2
|
#
|
4
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
4
|
# you may not use this file except in compliance with the License.
|
@@ -13,5 +12,119 @@
|
|
13
12
|
# See the License for the specific language governing permissions and
|
14
13
|
# limitations under the License.
|
15
14
|
|
16
|
-
|
17
15
|
require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
|
16
|
+
|
17
|
+
module Google
|
18
|
+
module Cloud
|
19
|
+
module Spanner
|
20
|
+
module Admin
|
21
|
+
# rubocop:disable LineLength
|
22
|
+
|
23
|
+
##
|
24
|
+
# # Ruby Client for Cloud Spanner Instance Admin API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
|
25
|
+
#
|
26
|
+
# [Cloud Spanner Instance Admin API][Product Documentation]:
|
27
|
+
#
|
28
|
+
# - [Product Documentation][]
|
29
|
+
#
|
30
|
+
# ## Quick Start
|
31
|
+
# In order to use this library, you first need to go through the following
|
32
|
+
# steps:
|
33
|
+
#
|
34
|
+
# 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
35
|
+
# 2. [Enable the Cloud Spanner Instance Admin API.](https://console.cloud.google.com/apis/api/spanner-admin-instance)
|
36
|
+
# 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
|
37
|
+
#
|
38
|
+
# ### Next Steps
|
39
|
+
# - Read the [Cloud Spanner Instance Admin API Product documentation][Product Documentation]
|
40
|
+
# to learn more about the product and see How-to Guides.
|
41
|
+
# - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
|
42
|
+
# to see the full list of Cloud APIs that we cover.
|
43
|
+
#
|
44
|
+
# [Product Documentation]: https://cloud.google.com/spanner-admin-instance
|
45
|
+
#
|
46
|
+
#
|
47
|
+
module Instance
|
48
|
+
module V1
|
49
|
+
# rubocop:enable LineLength
|
50
|
+
|
51
|
+
##
|
52
|
+
# Cloud Spanner Instance Admin API
|
53
|
+
#
|
54
|
+
# The Cloud Spanner Instance Admin API can be used to create, delete,
|
55
|
+
# modify and list instances. Instances are dedicated Cloud Spanner serving
|
56
|
+
# and storage resources to be used by Cloud Spanner databases.
|
57
|
+
#
|
58
|
+
# Each instance has a "configuration", which dictates where the
|
59
|
+
# serving resources for the Cloud Spanner instance are located (e.g.,
|
60
|
+
# US-central, Europe). Configurations are created by Google based on
|
61
|
+
# resource availability.
|
62
|
+
#
|
63
|
+
# Cloud Spanner billing is based on the instances that exist and their
|
64
|
+
# sizes. After an instance exists, there are no additional
|
65
|
+
# per-database or per-operation charges for use of the instance
|
66
|
+
# (though there may be additional network bandwidth charges).
|
67
|
+
# Instances offer isolation: problems with databases in one instance
|
68
|
+
# will not affect other instances. However, within an instance
|
69
|
+
# databases can affect each other. For example, if one database in an
|
70
|
+
# instance receives a lot of requests and consumes most of the
|
71
|
+
# instance resources, fewer resources are available for other
|
72
|
+
# databases in that instance, and their performance may suffer.
|
73
|
+
#
|
74
|
+
# @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
|
75
|
+
# Provides the means for authenticating requests made by the client. This parameter can
|
76
|
+
# be many types.
|
77
|
+
# A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
|
78
|
+
# authenticating requests made by this client.
|
79
|
+
# A `String` will be treated as the path to the keyfile to be used for the construction of
|
80
|
+
# credentials for this client.
|
81
|
+
# A `Hash` will be treated as the contents of a keyfile to be used for the construction of
|
82
|
+
# credentials for this client.
|
83
|
+
# A `GRPC::Core::Channel` will be used to make calls through.
|
84
|
+
# A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
|
85
|
+
# should already be composed with a `GRPC::Core::CallCredentials` object.
|
86
|
+
# A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
|
87
|
+
# metadata for requests, generally, to give OAuth credentials.
|
88
|
+
# @param scopes [Array<String>]
|
89
|
+
# The OAuth scopes for this service. This parameter is ignored if
|
90
|
+
# an updater_proc is supplied.
|
91
|
+
# @param client_config [Hash]
|
92
|
+
# A Hash for call options for each method. See
|
93
|
+
# Google::Gax#construct_settings for the structure of
|
94
|
+
# this data. Falls back to the default config if not specified
|
95
|
+
# or the specified config is missing data points.
|
96
|
+
# @param timeout [Numeric]
|
97
|
+
# The default timeout, in seconds, for calls made through this client.
|
98
|
+
def self.new \
|
99
|
+
service_path: nil,
|
100
|
+
port: nil,
|
101
|
+
channel: nil,
|
102
|
+
chan_creds: nil,
|
103
|
+
updater_proc: nil,
|
104
|
+
credentials: nil,
|
105
|
+
scopes: nil,
|
106
|
+
client_config: nil,
|
107
|
+
timeout: nil,
|
108
|
+
lib_name: nil,
|
109
|
+
lib_version: nil
|
110
|
+
kwargs = {
|
111
|
+
service_path: service_path,
|
112
|
+
port: port,
|
113
|
+
channel: channel,
|
114
|
+
chan_creds: chan_creds,
|
115
|
+
updater_proc: updater_proc,
|
116
|
+
credentials: credentials,
|
117
|
+
scopes: scopes,
|
118
|
+
client_config: client_config,
|
119
|
+
timeout: timeout,
|
120
|
+
lib_name: lib_name,
|
121
|
+
lib_version: lib_version
|
122
|
+
}.select { |_, v| v != nil }
|
123
|
+
Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.new(**kwargs)
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
130
|
+
end
|
@@ -45,7 +45,7 @@ module Google
|
|
45
45
|
# }
|
46
46
|
#
|
47
47
|
# For a description of IAM and its features, see the
|
48
|
-
#
|
48
|
+
# [IAM developer's guide](https://cloud.google.com/iam).
|
49
49
|
# @!attribute [rw] version
|
50
50
|
# @return [Integer]
|
51
51
|
# Version of the +Policy+. The default version is 0.
|
@@ -80,23 +80,23 @@ module Google
|
|
80
80
|
# +members+ can have the following values:
|
81
81
|
#
|
82
82
|
# * +allUsers+: A special identifier that represents anyone who is
|
83
|
-
#
|
83
|
+
# on the internet; with or without a Google account.
|
84
84
|
#
|
85
85
|
# * +allAuthenticatedUsers+: A special identifier that represents anyone
|
86
|
-
#
|
86
|
+
# who is authenticated with a Google account or a service account.
|
87
87
|
#
|
88
88
|
# * +user:{emailid}+: An email address that represents a specific Google
|
89
|
-
#
|
89
|
+
# account. For example, +alice@gmail.com+ or +joe@example.com+.
|
90
90
|
#
|
91
91
|
#
|
92
92
|
# * +serviceAccount:{emailid}+: An email address that represents a service
|
93
|
-
#
|
93
|
+
# account. For example, +my-other-app@appspot.gserviceaccount.com+.
|
94
94
|
#
|
95
95
|
# * +group:{emailid}+: An email address that represents a Google group.
|
96
|
-
#
|
96
|
+
# For example, +admins@example.com+.
|
97
97
|
#
|
98
98
|
# * +domain:{domain}+: A Google Apps domain name that represents all the
|
99
|
-
#
|
99
|
+
# users of that domain. For example, +google.com+ or +example.com+.
|
100
100
|
class Binding; end
|
101
101
|
|
102
102
|
# The difference delta between two policies.
|
@@ -136,4 +136,4 @@ module Google
|
|
136
136
|
end
|
137
137
|
end
|
138
138
|
end
|
139
|
-
end
|
139
|
+
end
|
@@ -49,6 +49,16 @@ module Google
|
|
49
49
|
# any.Unpack(foo)
|
50
50
|
# ...
|
51
51
|
#
|
52
|
+
# Example 4: Pack and unpack a message in Go
|
53
|
+
#
|
54
|
+
# foo := &pb.Foo{...}
|
55
|
+
# any, err := ptypes.MarshalAny(foo)
|
56
|
+
# ...
|
57
|
+
# foo := &pb.Foo{}
|
58
|
+
# if err := ptypes.UnmarshalAny(any, foo); err != nil {
|
59
|
+
# ...
|
60
|
+
# }
|
61
|
+
#
|
52
62
|
# The pack methods provided by protobuf library will by default use
|
53
63
|
# 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
54
64
|
# methods only use the fully qualified type name after the last '/'
|
@@ -77,7 +87,7 @@ module Google
|
|
77
87
|
# If the embedded message type is well-known and has a custom JSON
|
78
88
|
# representation, that representation will be embedded adding a field
|
79
89
|
# +value+ which holds the custom JSON in addition to the +@type+
|
80
|
-
# field. Example (for message Google::Protobuf::Duration):
|
90
|
+
# field. Example (for message {Google::Protobuf::Duration}):
|
81
91
|
#
|
82
92
|
# {
|
83
93
|
# "@type": "type.googleapis.com/google.protobuf.Duration",
|
@@ -96,7 +106,7 @@ module Google
|
|
96
106
|
# qualified name of the type (as in +path/google.protobuf.Duration+).
|
97
107
|
# The name should be in a canonical form (e.g., leading "." is
|
98
108
|
# not accepted).
|
99
|
-
# * An HTTP GET on the URL must yield a Google::Protobuf::Type
|
109
|
+
# * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
|
100
110
|
# value in binary format, or produce an error.
|
101
111
|
# * Applications are allowed to cache lookup results based on the
|
102
112
|
# URL, or have them precompiled into a binary to avoid any
|
@@ -16,22 +16,22 @@ module Google
|
|
16
16
|
module Rpc
|
17
17
|
# The +Status+ type defines a logical error model that is suitable for different
|
18
18
|
# programming environments, including REST APIs and RPC APIs. It is used by
|
19
|
-
#
|
19
|
+
# [gRPC](https://github.com/grpc). The error model is designed to be:
|
20
20
|
#
|
21
|
-
#
|
22
|
-
#
|
21
|
+
# * Simple to use and understand for most users
|
22
|
+
# * Flexible enough to meet unexpected needs
|
23
23
|
#
|
24
24
|
# = Overview
|
25
25
|
#
|
26
26
|
# The +Status+ message contains three pieces of data: error code, error message,
|
27
27
|
# and error details. The error code should be an enum value of
|
28
|
-
# Google::Rpc::Code, but it may accept additional error codes if needed. The
|
28
|
+
# {Google::Rpc::Code}, but it may accept additional error codes if needed. The
|
29
29
|
# error message should be a developer-facing English message that helps
|
30
30
|
# developers *understand* and *resolve* the error. If a localized user-facing
|
31
31
|
# error message is needed, put the localized message in the error details or
|
32
32
|
# localize it in the client. The optional error details may contain arbitrary
|
33
33
|
# information about the error. There is a predefined set of error detail types
|
34
|
-
# in the package +google.rpc+
|
34
|
+
# in the package +google.rpc+ that can be used for common error conditions.
|
35
35
|
#
|
36
36
|
# = Language mapping
|
37
37
|
#
|
@@ -49,35 +49,35 @@ module Google
|
|
49
49
|
#
|
50
50
|
# Example uses of this error model include:
|
51
51
|
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
52
|
+
# * Partial errors. If a service needs to return partial errors to the client,
|
53
|
+
# it may embed the +Status+ in the normal response to indicate the partial
|
54
|
+
# errors.
|
55
55
|
#
|
56
|
-
#
|
57
|
-
#
|
56
|
+
# * Workflow errors. A typical workflow has multiple steps. Each step may
|
57
|
+
# have a +Status+ message for error reporting.
|
58
58
|
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
59
|
+
# * Batch operations. If a client uses batch request and batch response, the
|
60
|
+
# +Status+ message should be used directly inside batch response, one for
|
61
|
+
# each error sub-response.
|
62
62
|
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
#
|
63
|
+
# * Asynchronous operations. If an API call embeds asynchronous operation
|
64
|
+
# results in its response, the status of those operations should be
|
65
|
+
# represented directly using the +Status+ message.
|
66
66
|
#
|
67
|
-
#
|
68
|
-
#
|
67
|
+
# * Logging. If some API errors are stored in logs, the message +Status+ could
|
68
|
+
# be used directly after any stripping needed for security/privacy reasons.
|
69
69
|
# @!attribute [rw] code
|
70
70
|
# @return [Integer]
|
71
|
-
# The status code, which should be an enum value of Google::Rpc::Code.
|
71
|
+
# The status code, which should be an enum value of {Google::Rpc::Code}.
|
72
72
|
# @!attribute [rw] message
|
73
73
|
# @return [String]
|
74
74
|
# A developer-facing error message, which should be in English. Any
|
75
75
|
# user-facing error message should be localized and sent in the
|
76
|
-
# Google::Rpc::Status#details field, or localized by the client.
|
76
|
+
# {Google::Rpc::Status#details} field, or localized by the client.
|
77
77
|
# @!attribute [rw] details
|
78
78
|
# @return [Array<Google::Protobuf::Any>]
|
79
|
-
# A list of messages that carry the error details. There
|
80
|
-
#
|
79
|
+
# A list of messages that carry the error details. There is a common set of
|
80
|
+
# message types for APIs to use.
|
81
81
|
class Status; end
|
82
82
|
end
|
83
83
|
end
|
@@ -16,6 +16,17 @@ module Google
|
|
16
16
|
module Spanner
|
17
17
|
module Admin
|
18
18
|
module Instance
|
19
|
+
##
|
20
|
+
# # Cloud Spanner Instance Admin API Contents
|
21
|
+
#
|
22
|
+
# | Class | Description |
|
23
|
+
# | ----- | ----------- |
|
24
|
+
# | [InstanceAdminClient][] | |
|
25
|
+
# | [Data Types][] | Data types for Google::Cloud::Spanner::Admin::Instance::V1 |
|
26
|
+
#
|
27
|
+
# [InstanceAdminClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-spanner-admin-instance/latest/google/spanner/admin/instance/v1/instanceadminclient
|
28
|
+
# [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-spanner-admin-instance/latest/google/spanner/admin/instance/v1/datatypes
|
29
|
+
#
|
19
30
|
module V1
|
20
31
|
# A possible configuration for a Cloud Spanner instance. Configurations
|
21
32
|
# define the geographic placement of nodes and their replication.
|
@@ -40,21 +51,25 @@ module Google
|
|
40
51
|
# @return [String]
|
41
52
|
# Required. The name of the instance's configuration. Values are of the form
|
42
53
|
# +projects/<project>/instanceConfigs/<configuration>+. See
|
43
|
-
# also InstanceConfig and
|
44
|
-
# ListInstanceConfigs.
|
54
|
+
# also {Google::Spanner::Admin::Instance::V1::InstanceConfig InstanceConfig} and
|
55
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs}.
|
45
56
|
# @!attribute [rw] display_name
|
46
57
|
# @return [String]
|
47
58
|
# Required. The descriptive name for this instance as it appears in UIs.
|
48
59
|
# Must be unique per project and between 4 and 30 characters in length.
|
49
60
|
# @!attribute [rw] node_count
|
50
61
|
# @return [Integer]
|
51
|
-
# Required. The number of nodes allocated to this instance.
|
62
|
+
# Required. The number of nodes allocated to this instance. This may be zero
|
63
|
+
# in API responses for instances that are not yet in state +READY+.
|
64
|
+
#
|
65
|
+
# See [the documentation](https://cloud.google.com/spanner/docs/instances#node_count)
|
66
|
+
# for more information about nodes.
|
52
67
|
# @!attribute [rw] state
|
53
68
|
# @return [Google::Spanner::Admin::Instance::V1::Instance::State]
|
54
69
|
# Output only. The current instance state. For
|
55
|
-
# CreateInstance, the state must be
|
70
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance}, the state must be
|
56
71
|
# either omitted or set to +CREATING+. For
|
57
|
-
# UpdateInstance, the state must be
|
72
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::UpdateInstance UpdateInstance}, the state must be
|
58
73
|
# either omitted or set to +READY+.
|
59
74
|
# @!attribute [rw] labels
|
60
75
|
# @return [Hash{String => String}]
|
@@ -65,11 +80,11 @@ module Google
|
|
65
80
|
# And they can be used as arguments to policy management rules (e.g. route,
|
66
81
|
# firewall, load balancing, etc.).
|
67
82
|
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
83
|
+
# * Label keys must be between 1 and 63 characters long and must conform to
|
84
|
+
# the following regular expression: +[a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?+.
|
85
|
+
# * Label values must be between 0 and 63 characters long and must conform
|
86
|
+
# to the regular expression +([a-z](https://cloud.google.com[-a-z0-9]*[a-z0-9])?)?+.
|
87
|
+
# * No more than 64 labels can be associated with a given resource.
|
73
88
|
#
|
74
89
|
# See https://goo.gl/xmQnxf for more information on and examples of labels.
|
75
90
|
#
|
@@ -96,7 +111,7 @@ module Google
|
|
96
111
|
end
|
97
112
|
end
|
98
113
|
|
99
|
-
# The request for ListInstanceConfigs.
|
114
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs}.
|
100
115
|
# @!attribute [rw] parent
|
101
116
|
# @return [String]
|
102
117
|
# Required. The name of the project for which a list of supported instance
|
@@ -109,37 +124,37 @@ module Google
|
|
109
124
|
# @!attribute [rw] page_token
|
110
125
|
# @return [String]
|
111
126
|
# If non-empty, +page_token+ should contain a
|
112
|
-
#
|
113
|
-
# from a previous ListInstanceConfigsResponse.
|
127
|
+
# {Google::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse#next_page_token next_page_token}
|
128
|
+
# from a previous {Google::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse ListInstanceConfigsResponse}.
|
114
129
|
class ListInstanceConfigsRequest; end
|
115
130
|
|
116
|
-
# The response for ListInstanceConfigs.
|
131
|
+
# The response for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs}.
|
117
132
|
# @!attribute [rw] instance_configs
|
118
133
|
# @return [Array<Google::Spanner::Admin::Instance::V1::InstanceConfig>]
|
119
134
|
# The list of requested instance configurations.
|
120
135
|
# @!attribute [rw] next_page_token
|
121
136
|
# @return [String]
|
122
137
|
# +next_page_token+ can be sent in a subsequent
|
123
|
-
# ListInstanceConfigs call to
|
138
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstanceConfigs ListInstanceConfigs} call to
|
124
139
|
# fetch more of the matching instance configurations.
|
125
140
|
class ListInstanceConfigsResponse; end
|
126
141
|
|
127
142
|
# The request for
|
128
|
-
# GetInstanceConfigRequest.
|
143
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::GetInstanceConfig GetInstanceConfigRequest}.
|
129
144
|
# @!attribute [rw] name
|
130
145
|
# @return [String]
|
131
146
|
# Required. The name of the requested instance configuration. Values are of
|
132
147
|
# the form +projects/<project>/instanceConfigs/<config>+.
|
133
148
|
class GetInstanceConfigRequest; end
|
134
149
|
|
135
|
-
# The request for GetInstance.
|
150
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::GetInstance GetInstance}.
|
136
151
|
# @!attribute [rw] name
|
137
152
|
# @return [String]
|
138
153
|
# Required. The name of the requested instance. Values are of the form
|
139
154
|
# +projects/<project>/instances/<instance>+.
|
140
155
|
class GetInstanceRequest; end
|
141
156
|
|
142
|
-
# The request for CreateInstance.
|
157
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance}.
|
143
158
|
# @!attribute [rw] parent
|
144
159
|
# @return [String]
|
145
160
|
# Required. The name of the project in which to create the instance. Values
|
@@ -155,7 +170,7 @@ module Google
|
|
155
170
|
# specified must be +<parent>/instances/<instance_id>+.
|
156
171
|
class CreateInstanceRequest; end
|
157
172
|
|
158
|
-
# The request for ListInstances.
|
173
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstances ListInstances}.
|
159
174
|
# @!attribute [rw] parent
|
160
175
|
# @return [String]
|
161
176
|
# Required. The name of the project for which a list of instances is
|
@@ -167,43 +182,43 @@ module Google
|
|
167
182
|
# @!attribute [rw] page_token
|
168
183
|
# @return [String]
|
169
184
|
# If non-empty, +page_token+ should contain a
|
170
|
-
#
|
171
|
-
# previous ListInstancesResponse.
|
185
|
+
# {Google::Spanner::Admin::Instance::V1::ListInstancesResponse#next_page_token next_page_token} from a
|
186
|
+
# previous {Google::Spanner::Admin::Instance::V1::ListInstancesResponse ListInstancesResponse}.
|
172
187
|
# @!attribute [rw] filter
|
173
188
|
# @return [String]
|
174
189
|
# An expression for filtering the results of the request. Filter rules are
|
175
190
|
# case insensitive. The fields eligible for filtering are:
|
176
191
|
#
|
177
|
-
#
|
178
|
-
# * display_name
|
179
|
-
# * labels.key where key is the name of a label
|
192
|
+
# * +name+
|
193
|
+
# * +display_name+
|
194
|
+
# * +labels.key+ where key is the name of a label
|
180
195
|
#
|
181
|
-
#
|
196
|
+
# Some examples of using filters are:
|
182
197
|
#
|
183
|
-
# * name
|
184
|
-
# * name:Howl --> The instance's name contains the string "howl".
|
185
|
-
# * name:HOWL --> Equivalent to above.
|
186
|
-
# * NAME:howl --> Equivalent to above.
|
187
|
-
# * labels.env
|
188
|
-
# * labels.env:dev --> The instance has the label "env" and the value of
|
189
|
-
#
|
190
|
-
# * name:howl labels.env:dev --> The instance's name contains "howl" and
|
191
|
-
#
|
192
|
-
#
|
198
|
+
# * +name:*+ --> The instance has a name.
|
199
|
+
# * +name:Howl+ --> The instance's name contains the string "howl".
|
200
|
+
# * +name:HOWL+ --> Equivalent to above.
|
201
|
+
# * +NAME:howl+ --> Equivalent to above.
|
202
|
+
# * +labels.env:*+ --> The instance has the label "env".
|
203
|
+
# * +labels.env:dev+ --> The instance has the label "env" and the value of
|
204
|
+
# the label contains the string "dev".
|
205
|
+
# * +name:howl labels.env:dev+ --> The instance's name contains "howl" and
|
206
|
+
# it has the label "env" with its value
|
207
|
+
# containing "dev".
|
193
208
|
class ListInstancesRequest; end
|
194
209
|
|
195
|
-
# The response for ListInstances.
|
210
|
+
# The response for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstances ListInstances}.
|
196
211
|
# @!attribute [rw] instances
|
197
212
|
# @return [Array<Google::Spanner::Admin::Instance::V1::Instance>]
|
198
213
|
# The list of requested instances.
|
199
214
|
# @!attribute [rw] next_page_token
|
200
215
|
# @return [String]
|
201
216
|
# +next_page_token+ can be sent in a subsequent
|
202
|
-
# ListInstances call to fetch more
|
217
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::ListInstances ListInstances} call to fetch more
|
203
218
|
# of the matching instances.
|
204
219
|
class ListInstancesResponse; end
|
205
220
|
|
206
|
-
# The request for UpdateInstance.
|
221
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::UpdateInstance UpdateInstance}.
|
207
222
|
# @!attribute [rw] instance
|
208
223
|
# @return [Google::Spanner::Admin::Instance::V1::Instance]
|
209
224
|
# Required. The instance to update, which must always include the instance
|
@@ -216,7 +231,7 @@ module Google
|
|
216
231
|
# about them.
|
217
232
|
class UpdateInstanceRequest; end
|
218
233
|
|
219
|
-
# The request for DeleteInstance.
|
234
|
+
# The request for {Google::Spanner::Admin::Instance::V1::InstanceAdmin::DeleteInstance DeleteInstance}.
|
220
235
|
# @!attribute [rw] name
|
221
236
|
# @return [String]
|
222
237
|
# Required. The name of the instance to be deleted. Values are of the form
|
@@ -224,14 +239,14 @@ module Google
|
|
224
239
|
class DeleteInstanceRequest; end
|
225
240
|
|
226
241
|
# Metadata type for the operation returned by
|
227
|
-
# CreateInstance.
|
242
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance}.
|
228
243
|
# @!attribute [rw] instance
|
229
244
|
# @return [Google::Spanner::Admin::Instance::V1::Instance]
|
230
245
|
# The instance being created.
|
231
246
|
# @!attribute [rw] start_time
|
232
247
|
# @return [Google::Protobuf::Timestamp]
|
233
248
|
# The time at which the
|
234
|
-
# CreateInstance request was
|
249
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::CreateInstance CreateInstance} request was
|
235
250
|
# received.
|
236
251
|
# @!attribute [rw] cancel_time
|
237
252
|
# @return [Google::Protobuf::Timestamp]
|
@@ -244,13 +259,13 @@ module Google
|
|
244
259
|
class CreateInstanceMetadata; end
|
245
260
|
|
246
261
|
# Metadata type for the operation returned by
|
247
|
-
# UpdateInstance.
|
262
|
+
# {Google::Spanner::Admin::Instance::V1::InstanceAdmin::UpdateInstance UpdateInstance}.
|
248
263
|
# @!attribute [rw] instance
|
249
264
|
# @return [Google::Spanner::Admin::Instance::V1::Instance]
|
250
265
|
# The desired end state of the update.
|
251
266
|
# @!attribute [rw] start_time
|
252
267
|
# @return [Google::Protobuf::Timestamp]
|
253
|
-
# The time at which UpdateInstance
|
268
|
+
# The time at which {Google::Spanner::Admin::Instance::V1::InstanceAdmin::UpdateInstance UpdateInstance}
|
254
269
|
# request was received.
|
255
270
|
# @!attribute [rw] cancel_time
|
256
271
|
# @return [Google::Protobuf::Timestamp]
|