google-cloud-spanner-admin-instance-v1 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9f4b930665fa5510469dcba70bde930ccbad070e1a44db84891e3c6e9b3ff854
4
- data.tar.gz: fb338861f0d32017e1ee785d41ac5a3fd2cda5e8eaf2c5aa14bde1eb1c170807
3
+ metadata.gz: ba927f55d45a60fc28a5cf5b532bece42c79135ab0aec4b140cc122da471806b
4
+ data.tar.gz: 46983792458f46ba21701efa93528cf2c0c526739f78a96045f85e0f58969c73
5
5
  SHA512:
6
- metadata.gz: 24d07f5aa093e90259a24e67e98745f2f395ad1536f3d76e2083459e2e29f4fcbee51479b9427d80d6cac896b2097e3738dc8a3ed7babd0a981a541e6b852723
7
- data.tar.gz: 26e73efa825040c92c245a8f35eab0927862672d57bb65cbde47fc46fec94d2e352a359206b30a37a20398c4edc3d761026f7dac93d042876d2e95854c29e8ad
6
+ metadata.gz: 16e418a9616faca18971dcdace9a38022deefcfab28c42bf3d9853e1ebeb335a4bcac75017f98ec641d2123a73bc41aaaa43b2d9726253208cc665a9aa47981e
7
+ data.tar.gz: aeb0d5897785ea6eed991808dc324d7caf0efbe11de8313d4bc936811c1637822c551d6a54e183f9e49a03f0e083feeaf618ba077f0682ccd68d550cc931e4ef
data/AUTHENTICATION.md CHANGED
@@ -19,7 +19,7 @@ during development.
19
19
  2. Set the [environment variable](#environment-variables).
20
20
 
21
21
  ```sh
22
- export SPANNER_INSTANCE_ADMIN_CREDENTIALS=path/to/keyfile.json
22
+ export SPANNER_CREDENTIALS=path/to/keyfile.json
23
23
  ```
24
24
 
25
25
  3. Initialize the client.
@@ -66,8 +66,8 @@ The environment variables that google-cloud-spanner-admin-instance-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Credentials}):
68
68
 
69
- 1. `SPANNER_INSTANCE_ADMIN_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `SPANNER_INSTANCE_ADMIN_KEYFILE` - Path to JSON file, or JSON contents
69
+ 1. `SPANNER_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ 2. `SPANNER_KEYFILE` - Path to JSON file, or JSON contents
71
71
  3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
72
  4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
73
  5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
@@ -75,7 +75,7 @@ checks for credentials are configured on the service Credentials class (such as
75
75
  ```ruby
76
76
  require "google/cloud/spanner/admin/instance/v1"
77
77
 
78
- ENV["SPANNER_INSTANCE_ADMIN_CREDENTIALS"] = "path/to/keyfile.json"
78
+ ENV["SPANNER_CREDENTIALS"] = "path/to/keyfile.json"
79
79
 
80
80
  client = ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client.new
81
81
  ```
data/README.md CHANGED
@@ -6,6 +6,12 @@ Cloud Spanner is a managed, mission-critical, globally consistent and scalable r
6
6
 
7
7
  https://github.com/googleapis/google-cloud-ruby
8
8
 
9
+ This gem is a _versioned_ client. It provides basic client classes for a
10
+ specific version of the Cloud Spanner Instance Admin V1 API. Most users should consider using
11
+ the main client gem,
12
+ [google-cloud-spanner-admin-instance](https://rubygems.org/gems/google-cloud-spanner-admin-instance).
13
+ See the section below titled *Which client should I use?* for more information.
14
+
9
15
  ## Installation
10
16
 
11
17
  ```
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
73
79
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
74
80
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
75
81
  about the Ruby support schedule.
82
+
83
+ ## Which client should I use?
84
+
85
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
+ client library with a name such as `google-cloud-spanner-admin-instance`,
87
+ and lower-level _versioned_ client libraries with names such as
88
+ `google-cloud-spanner-admin-instance-v1`.
89
+ _In most cases, you should install the main client._
90
+
91
+ ### What's the difference between the main client and a versioned client?
92
+
93
+ A _versioned client_ provides a basic set of data types and client classes for
94
+ a _single version_ of a specific service. (That is, for a service with multiple
95
+ versions, there might be a separate versioned client for each service version.)
96
+ Most versioned clients are written and maintained by a code generator.
97
+
98
+ The _main client_ is designed to provide you with the _recommended_ client
99
+ interfaces for the service. There will be only one main client for any given
100
+ service, even a service with multiple versions. The main client includes
101
+ factory methods for constructing the client objects we recommend for most
102
+ users. In some cases, those will be classes provided by an underlying versioned
103
+ client; in other cases, they will be handwritten higher-level client objects
104
+ with additional capabilities, convenience methods, or best practices built in.
105
+ Generally, the main client will default to a recommended service version,
106
+ although in some cases you can override this if you need to talk to a specific
107
+ service version.
108
+
109
+ ### Why would I want to use the main client?
110
+
111
+ We recommend that most users install the main client gem for a service. You can
112
+ identify this gem as the one _without_ a version in its name, e.g.
113
+ `google-cloud-spanner-admin-instance`.
114
+ The main client is recommended because it will embody the best practices for
115
+ accessing the service, and may also provide more convenient interfaces or
116
+ tighter integration into frameworks and third-party libraries. In addition, the
117
+ documentation and samples published by Google will generally demonstrate use of
118
+ the main client.
119
+
120
+ ### Why would I want to use a versioned client?
121
+
122
+ You can use a versioned client if you are content with a possibly lower-level
123
+ class interface, you explicitly want to avoid features provided by the main
124
+ client, or you want to access a specific service version not be covered by the
125
+ main client. You can identify versioned client gems because the service version
126
+ is part of the name, e.g. `google-cloud-spanner-admin-instance-v1`.
127
+
128
+ ### What about the google-apis-<name> clients?
129
+
130
+ Client library gems with names that begin with `google-apis-` are based on an
131
+ older code generation technology. They talk to a REST/JSON backend (whereas
132
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
133
+ not offer the same performance, features, and ease of use provided by more
134
+ modern clients.
135
+
136
+ The `google-apis-` clients have wide coverage across Google services, so you
137
+ might need to use one if there is no modern client available for the service.
138
+ However, if a modern client is available, we generally recommend it over the
139
+ older `google-apis-` clients.
@@ -37,3 +37,6 @@ module Google
37
37
  end
38
38
  end
39
39
  end
40
+
41
+ helper_path = ::File.join __dir__, "v1", "_helpers.rb"
42
+ require "google/cloud/spanner/admin/instance/v1/_helpers" if ::File.file? helper_path
@@ -92,7 +92,7 @@ module Google
92
92
  initial_delay: 1.0,
93
93
  max_delay: 32.0,
94
94
  multiplier: 1.3,
95
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
95
+ retry_codes: [14, 4]
96
96
  }
97
97
 
98
98
  default_config.rpcs.get_instance_config.timeout = 3600.0
@@ -100,7 +100,7 @@ module Google
100
100
  initial_delay: 1.0,
101
101
  max_delay: 32.0,
102
102
  multiplier: 1.3,
103
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
103
+ retry_codes: [14, 4]
104
104
  }
105
105
 
106
106
  default_config.rpcs.list_instances.timeout = 3600.0
@@ -108,7 +108,7 @@ module Google
108
108
  initial_delay: 1.0,
109
109
  max_delay: 32.0,
110
110
  multiplier: 1.3,
111
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
111
+ retry_codes: [14, 4]
112
112
  }
113
113
 
114
114
  default_config.rpcs.get_instance.timeout = 3600.0
@@ -116,7 +116,7 @@ module Google
116
116
  initial_delay: 1.0,
117
117
  max_delay: 32.0,
118
118
  multiplier: 1.3,
119
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
119
+ retry_codes: [14, 4]
120
120
  }
121
121
 
122
122
  default_config.rpcs.create_instance.timeout = 3600.0
@@ -128,7 +128,7 @@ module Google
128
128
  initial_delay: 1.0,
129
129
  max_delay: 32.0,
130
130
  multiplier: 1.3,
131
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
131
+ retry_codes: [14, 4]
132
132
  }
133
133
 
134
134
  default_config.rpcs.set_iam_policy.timeout = 30.0
@@ -138,7 +138,7 @@ module Google
138
138
  initial_delay: 1.0,
139
139
  max_delay: 32.0,
140
140
  multiplier: 1.3,
141
- retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
141
+ retry_codes: [14, 4]
142
142
  }
143
143
 
144
144
  default_config.rpcs.test_iam_permissions.timeout = 30.0
@@ -204,7 +204,13 @@ module Google
204
204
 
205
205
  # Create credentials
206
206
  credentials = @config.credentials
207
- credentials ||= Credentials.default scope: @config.scope
207
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
208
+ # but only if the default endpoint does not have a region prefix.
209
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
210
+ @config.endpoint == Client.configure.endpoint &&
211
+ !@config.endpoint.split(".").first.include?("-")
212
+ credentials ||= Credentials.default scope: @config.scope,
213
+ enable_self_signed_jwt: enable_self_signed_jwt
208
214
  if credentials.is_a?(String) || credentials.is_a?(Hash)
209
215
  credentials = Credentials.new credentials, scope: @config.scope
210
216
  end
@@ -1152,7 +1158,7 @@ module Google
1152
1158
 
1153
1159
  config_attr :endpoint, "spanner.googleapis.com", ::String
1154
1160
  config_attr :credentials, nil do |value|
1155
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1161
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1156
1162
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
1157
1163
  allowed.any? { |klass| klass === value }
1158
1164
  end
@@ -1192,7 +1198,7 @@ module Google
1192
1198
  # Each configuration object is of type `Gapic::Config::Method` and includes
1193
1199
  # the following configuration fields:
1194
1200
  #
1195
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
1201
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
1196
1202
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
1197
1203
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
1198
1204
  # include the following keys:
@@ -32,13 +32,13 @@ module Google
32
32
  "https://www.googleapis.com/auth/spanner.admin"
33
33
  ]
34
34
  self.env_vars = [
35
- "SPANNER_INSTANCE_ADMIN_CREDENTIALS",
36
- "SPANNER_INSTANCE_ADMIN_KEYFILE",
35
+ "SPANNER_CREDENTIALS",
36
+ "SPANNER_KEYFILE",
37
37
  "GOOGLE_CLOUD_CREDENTIALS",
38
38
  "GOOGLE_CLOUD_KEYFILE",
39
39
  "GCLOUD_KEYFILE",
40
- "SPANNER_INSTANCE_ADMIN_CREDENTIALS_JSON",
41
- "SPANNER_INSTANCE_ADMIN_KEYFILE_JSON",
40
+ "SPANNER_CREDENTIALS_JSON",
41
+ "SPANNER_KEYFILE_JSON",
42
42
  "GOOGLE_CLOUD_CREDENTIALS_JSON",
43
43
  "GOOGLE_CLOUD_KEYFILE_JSON",
44
44
  "GCLOUD_KEYFILE_JSON"
@@ -105,8 +105,13 @@ module Google
105
105
  # Lists operations that match the specified filter in the request. If the
106
106
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
107
107
  #
108
- # NOTE: the `name` binding below allows API services to override the binding
109
- # to use different resource name schemes, such as `users/*/operations`.
108
+ # NOTE: the `name` binding allows API services to override the binding
109
+ # to use different resource name schemes, such as `users/*/operations`. To
110
+ # override the binding, API services can add a binding such as
111
+ # `"/v1/{name=users/*}/operations"` to their service configuration.
112
+ # For backwards compatibility, the default name includes the operations
113
+ # collection id, however overriding users must ensure the name binding
114
+ # is the parent resource, without the operations collection id.
110
115
  #
111
116
  # @overload list_operations(request, options = nil)
112
117
  # Pass arguments to `list_operations` via a request object, either of type
@@ -124,7 +129,7 @@ module Google
124
129
  # the default parameter values, pass an empty Hash as a request object (see above).
125
130
  #
126
131
  # @param name [::String]
127
- # The name of the operation collection.
132
+ # The name of the operation's parent resource.
128
133
  # @param filter [::String]
129
134
  # The standard list filter.
130
135
  # @param page_size [::Integer]
@@ -392,6 +397,79 @@ module Google
392
397
  raise ::Google::Cloud::Error.from_error(e)
393
398
  end
394
399
 
400
+ ##
401
+ # Waits for the specified long-running operation until it is done or reaches
402
+ # at most a specified timeout, returning the latest state. If the operation
403
+ # is already done, the latest state is immediately returned. If the timeout
404
+ # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
405
+ # timeout is used. If the server does not support this method, it returns
406
+ # `google.rpc.Code.UNIMPLEMENTED`.
407
+ # Note that this method is on a best-effort basis. It may return the latest
408
+ # state before the specified timeout (including immediately), meaning even an
409
+ # immediate response is no guarantee that the operation is done.
410
+ #
411
+ # @overload wait_operation(request, options = nil)
412
+ # Pass arguments to `wait_operation` via a request object, either of type
413
+ # {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
414
+ #
415
+ # @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
416
+ # A request object representing the call parameters. Required. To specify no
417
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
418
+ # @param options [::Gapic::CallOptions, ::Hash]
419
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
420
+ #
421
+ # @overload wait_operation(name: nil, timeout: nil)
422
+ # Pass arguments to `wait_operation` via keyword arguments. Note that at
423
+ # least one keyword argument is required. To specify no parameters, or to keep all
424
+ # the default parameter values, pass an empty Hash as a request object (see above).
425
+ #
426
+ # @param name [::String]
427
+ # The name of the operation resource to wait on.
428
+ # @param timeout [::Google::Protobuf::Duration, ::Hash]
429
+ # The maximum duration to wait before timing out. If left blank, the wait
430
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
431
+ # If RPC context deadline is also specified, the shorter one will be used.
432
+ #
433
+ # @yield [response, operation] Access the result along with the RPC operation
434
+ # @yieldparam response [::Gapic::Operation]
435
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
436
+ #
437
+ # @return [::Gapic::Operation]
438
+ #
439
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
440
+ #
441
+ def wait_operation request, options = nil
442
+ raise ::ArgumentError, "request must be provided" if request.nil?
443
+
444
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
445
+
446
+ # Converts hash and nil to an options object
447
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
448
+
449
+ # Customize the options with defaults
450
+ metadata = @config.rpcs.wait_operation.metadata.to_h
451
+
452
+ # Set x-goog-api-client and x-goog-user-project headers
453
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
454
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
455
+ gapic_version: ::Google::Cloud::Spanner::Admin::Instance::V1::VERSION
456
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
457
+
458
+ options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
459
+ metadata: metadata,
460
+ retry_policy: @config.rpcs.wait_operation.retry_policy
461
+ options.apply_defaults metadata: @config.metadata,
462
+ retry_policy: @config.retry_policy
463
+
464
+ @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
465
+ response = ::Gapic::Operation.new response, @operations_client, options: options
466
+ yield response, operation if block_given?
467
+ return response
468
+ end
469
+ rescue ::GRPC::BadStatus => e
470
+ raise ::Google::Cloud::Error.from_error(e)
471
+ end
472
+
395
473
  ##
396
474
  # Configuration class for the Operations API.
397
475
  #
@@ -477,7 +555,7 @@ module Google
477
555
 
478
556
  config_attr :endpoint, "spanner.googleapis.com", ::String
479
557
  config_attr :credentials, nil do |value|
480
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
558
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
481
559
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
482
560
  allowed.any? { |klass| klass === value }
483
561
  end
@@ -517,7 +595,7 @@ module Google
517
595
  # Each configuration object is of type `Gapic::Config::Method` and includes
518
596
  # the following configuration fields:
519
597
  #
520
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
598
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
521
599
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
522
600
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
523
601
  # include the following keys:
@@ -548,6 +626,11 @@ module Google
548
626
  # @return [::Gapic::Config::Method]
549
627
  #
550
628
  attr_reader :cancel_operation
629
+ ##
630
+ # RPC-specific configuration for `wait_operation`
631
+ # @return [::Gapic::Config::Method]
632
+ #
633
+ attr_reader :wait_operation
551
634
 
552
635
  # @private
553
636
  def initialize parent_rpcs = nil
@@ -559,6 +642,8 @@ module Google
559
642
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
560
643
  cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
561
644
  @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
645
+ wait_operation_config = parent_rpcs&.wait_operation if parent_rpcs&.respond_to? :wait_operation
646
+ @wait_operation = ::Gapic::Config::Method.new wait_operation_config
562
647
 
563
648
  yield self if block_given?
564
649
  end
@@ -23,7 +23,7 @@ module Google
23
23
  module Admin
24
24
  module Instance
25
25
  module V1
26
- VERSION = "0.1.0"
26
+ VERSION = "0.2.0"
27
27
  end
28
28
  end
29
29
  end
@@ -56,13 +56,13 @@ module Google
56
56
  self.service_name = 'google.spanner.admin.instance.v1.InstanceAdmin'
57
57
 
58
58
  # Lists the supported instance configurations for a given project.
59
- rpc :ListInstanceConfigs, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
59
+ rpc :ListInstanceConfigs, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstanceConfigsResponse
60
60
  # Gets information about a particular instance configuration.
61
- rpc :GetInstanceConfig, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest, Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
61
+ rpc :GetInstanceConfig, ::Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceConfigRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig
62
62
  # Lists all instances in the given project.
63
- rpc :ListInstances, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest, Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
63
+ rpc :ListInstances, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesResponse
64
64
  # Gets information about a particular instance.
65
- rpc :GetInstance, Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceRequest, Google::Cloud::Spanner::Admin::Instance::V1::Instance
65
+ rpc :GetInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::GetInstanceRequest, ::Google::Cloud::Spanner::Admin::Instance::V1::Instance
66
66
  # Creates an instance and begins preparing it to begin serving. The
67
67
  # returned [long-running operation][google.longrunning.Operation]
68
68
  # can be used to track the progress of preparing the new
@@ -97,7 +97,7 @@ module Google
97
97
  # [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
98
98
  # The [response][google.longrunning.Operation.response] field type is
99
99
  # [Instance][google.spanner.admin.instance.v1.Instance], if successful.
100
- rpc :CreateInstance, Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceRequest, Google::Longrunning::Operation
100
+ rpc :CreateInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceRequest, ::Google::Longrunning::Operation
101
101
  # Updates an instance, and begins allocating or releasing resources
102
102
  # as requested. The returned [long-running
103
103
  # operation][google.longrunning.Operation] can be used to track the
@@ -138,7 +138,7 @@ module Google
138
138
  #
139
139
  # Authorization requires `spanner.instances.update` permission on
140
140
  # resource [name][google.spanner.admin.instance.v1.Instance.name].
141
- rpc :UpdateInstance, Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest, Google::Longrunning::Operation
141
+ rpc :UpdateInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceRequest, ::Google::Longrunning::Operation
142
142
  # Deletes an instance.
143
143
  #
144
144
  # Immediately upon completion of the request:
@@ -150,26 +150,26 @@ module Google
150
150
  # * The instance and *all of its databases* immediately and
151
151
  # irrevocably disappear from the API. All data in the databases
152
152
  # is permanently deleted.
153
- rpc :DeleteInstance, Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceRequest, Google::Protobuf::Empty
153
+ rpc :DeleteInstance, ::Google::Cloud::Spanner::Admin::Instance::V1::DeleteInstanceRequest, ::Google::Protobuf::Empty
154
154
  # Sets the access control policy on an instance resource. Replaces any
155
155
  # existing policy.
156
156
  #
157
157
  # Authorization requires `spanner.instances.setIamPolicy` on
158
158
  # [resource][google.iam.v1.SetIamPolicyRequest.resource].
159
- rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
159
+ rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
160
160
  # Gets the access control policy for an instance resource. Returns an empty
161
161
  # policy if an instance exists but does not have a policy set.
162
162
  #
163
163
  # Authorization requires `spanner.instances.getIamPolicy` on
164
164
  # [resource][google.iam.v1.GetIamPolicyRequest.resource].
165
- rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
165
+ rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
166
166
  # Returns permissions that the caller has on the specified instance resource.
167
167
  #
168
168
  # Attempting this RPC on a non-existent Cloud Spanner instance resource will
169
169
  # result in a NOT_FOUND error if the user has `spanner.instances.list`
170
170
  # permission on the containing Google Cloud Project. Otherwise returns an
171
171
  # empty set of permissions.
172
- rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
172
+ rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
173
173
  end
174
174
 
175
175
  Stub = Service.rpc_stub_class
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,7 +25,7 @@ module Google
25
25
  # @return [::String]
26
26
  # The server-assigned name, which is only unique within the same service that
27
27
  # originally returns it. If you use the default HTTP mapping, the
28
- # `name` should have the format of `operations/some/unique/name`.
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
29
  # @!attribute [rw] metadata
30
30
  # @return [::Google::Protobuf::Any]
31
31
  # Service-specific metadata associated with the operation. It typically
@@ -35,7 +35,7 @@ module Google
35
35
  # @!attribute [rw] done
36
36
  # @return [::Boolean]
37
37
  # If the value is `false`, it means the operation is still in progress.
38
- # If true, the operation is completed, and either `error` or `response` is
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
39
  # available.
40
40
  # @!attribute [rw] error
41
41
  # @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
67
67
  # The request message for Operations.ListOperations.
68
68
  # @!attribute [rw] name
69
69
  # @return [::String]
70
- # The name of the operation collection.
70
+ # The name of the operation's parent resource.
71
71
  # @!attribute [rw] filter
72
72
  # @return [::String]
73
73
  # The standard list filter.
@@ -112,6 +112,20 @@ module Google
112
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
114
 
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
115
129
  # A message representing the message types used by a long-running operation.
116
130
  #
117
131
  # Example:
@@ -57,10 +57,13 @@ module Google
57
57
  # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
- # any, err := ptypes.MarshalAny(foo)
60
+ # any, err := anypb.New(foo)
61
+ # if err != nil {
62
+ # ...
63
+ # }
61
64
  # ...
62
65
  # foo := &pb.Foo{}
63
- # if err := ptypes.UnmarshalAny(any, foo); err != nil {
66
+ # if err := any.UnmarshalTo(foo); err != nil {
64
67
  # ...
65
68
  # }
66
69
  #
@@ -0,0 +1,98 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Protobuf
22
+ # A Duration represents a signed, fixed-length span of time represented
23
+ # as a count of seconds and fractions of seconds at nanosecond
24
+ # resolution. It is independent of any calendar and concepts like "day"
25
+ # or "month". It is related to Timestamp in that the difference between
26
+ # two Timestamp values is a Duration and it can be added or subtracted
27
+ # from a Timestamp. Range is approximately +-10,000 years.
28
+ #
29
+ # # Examples
30
+ #
31
+ # Example 1: Compute Duration from two Timestamps in pseudo code.
32
+ #
33
+ # Timestamp start = ...;
34
+ # Timestamp end = ...;
35
+ # Duration duration = ...;
36
+ #
37
+ # duration.seconds = end.seconds - start.seconds;
38
+ # duration.nanos = end.nanos - start.nanos;
39
+ #
40
+ # if (duration.seconds < 0 && duration.nanos > 0) {
41
+ # duration.seconds += 1;
42
+ # duration.nanos -= 1000000000;
43
+ # } else if (duration.seconds > 0 && duration.nanos < 0) {
44
+ # duration.seconds -= 1;
45
+ # duration.nanos += 1000000000;
46
+ # }
47
+ #
48
+ # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
49
+ #
50
+ # Timestamp start = ...;
51
+ # Duration duration = ...;
52
+ # Timestamp end = ...;
53
+ #
54
+ # end.seconds = start.seconds + duration.seconds;
55
+ # end.nanos = start.nanos + duration.nanos;
56
+ #
57
+ # if (end.nanos < 0) {
58
+ # end.seconds -= 1;
59
+ # end.nanos += 1000000000;
60
+ # } else if (end.nanos >= 1000000000) {
61
+ # end.seconds += 1;
62
+ # end.nanos -= 1000000000;
63
+ # }
64
+ #
65
+ # Example 3: Compute Duration from datetime.timedelta in Python.
66
+ #
67
+ # td = datetime.timedelta(days=3, minutes=10)
68
+ # duration = Duration()
69
+ # duration.FromTimedelta(td)
70
+ #
71
+ # # JSON Mapping
72
+ #
73
+ # In JSON format, the Duration type is encoded as a string rather than an
74
+ # object, where the string ends in the suffix "s" (indicating seconds) and
75
+ # is preceded by the number of seconds, with nanoseconds expressed as
76
+ # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
77
+ # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
78
+ # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
79
+ # microsecond should be expressed in JSON format as "3.000001s".
80
+ # @!attribute [rw] seconds
81
+ # @return [::Integer]
82
+ # Signed seconds of the span of time. Must be from -315,576,000,000
83
+ # to +315,576,000,000 inclusive. Note: these bounds are computed from:
84
+ # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
85
+ # @!attribute [rw] nanos
86
+ # @return [::Integer]
87
+ # Signed fractions of a second at nanosecond resolution of the span
88
+ # of time. Durations less than one second are represented with a 0
89
+ # `seconds` field and a positive or negative `nanos` field. For durations
90
+ # of one second or more, a non-zero value for the `nanos` field must be
91
+ # of the same sign as the `seconds` field. Must be from -999,999,999
92
+ # to +999,999,999 inclusive.
93
+ class Duration
94
+ include ::Google::Protobuf::MessageExts
95
+ extend ::Google::Protobuf::MessageExts::ClassMethods
96
+ end
97
+ end
98
+ end
@@ -70,7 +70,16 @@ module Google
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
72
  #
73
- # Example 5: Compute Timestamp from current time in Python.
73
+ # Example 5: Compute Timestamp from Java `Instant.now()`.
74
+ #
75
+ # Instant now = Instant.now();
76
+ #
77
+ # Timestamp timestamp =
78
+ # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
+ # .setNanos(now.getNano()).build();
80
+ #
81
+ #
82
+ # Example 6: Compute Timestamp from current time in Python.
74
83
  #
75
84
  # timestamp = Timestamp()
76
85
  # timestamp.GetCurrentTime()
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-spanner-admin-instance-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-07-06 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -171,7 +171,10 @@ dependencies:
171
171
  - !ruby/object:Gem::Version
172
172
  version: '0.9'
173
173
  description: Cloud Spanner is a managed, mission-critical, globally consistent and
174
- scalable relational database service.
174
+ scalable relational database service. Note that google-cloud-spanner-admin-instance-v1
175
+ is a version-specific client library. For most uses, we recommend installing the
176
+ main client library google-cloud-spanner-admin-instance instead. See the readme
177
+ for more details.
175
178
  email: googleapis-packages@google.com
176
179
  executables: []
177
180
  extensions: []
@@ -199,6 +202,7 @@ files:
199
202
  - proto_docs/google/iam/v1/policy.rb
200
203
  - proto_docs/google/longrunning/operations.rb
201
204
  - proto_docs/google/protobuf/any.rb
205
+ - proto_docs/google/protobuf/duration.rb
202
206
  - proto_docs/google/protobuf/empty.rb
203
207
  - proto_docs/google/protobuf/field_mask.rb
204
208
  - proto_docs/google/protobuf/timestamp.rb
@@ -224,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
224
228
  - !ruby/object:Gem::Version
225
229
  version: '0'
226
230
  requirements: []
227
- rubygems_version: 3.1.3
231
+ rubygems_version: 3.2.6
228
232
  signing_key:
229
233
  specification_version: 4
230
234
  summary: API Client library for the Cloud Spanner Instance Admin V1 API