Class: Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb

Overview

Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"spanner.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/spanner.admin"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ InstanceAdminClient

Returns a new instance of InstanceAdminClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 187

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/spanner/admin/instance/v1/spanner_instance_admin_services_pb"

  credentials ||= Google::Cloud::Spanner::Admin::Instance::V1::Credentials.default

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    service_address: service_address,
    service_port: service_port,
    lib_name: lib_name,
    lib_version: lib_version,
    metadata: metadata,
  )

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Spanner::Admin::Instance::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Spanner::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "instance_admin_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.spanner.admin.instance.v1.InstanceAdmin",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @instance_admin_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Spanner::Admin::Instance::V1::InstanceAdmin::Stub.method(:new)
  )

  @list_instance_configs = Google::Gax.create_api_call(
    @instance_admin_stub.method(:list_instance_configs),
    defaults["list_instance_configs"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_instance_config = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_instance_config),
    defaults["get_instance_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_instances = Google::Gax.create_api_call(
    @instance_admin_stub.method(:list_instances),
    defaults["list_instances"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_instance),
    defaults["get_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:create_instance),
    defaults["create_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:update_instance),
    defaults["update_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'instance.name' => request.instance.name}
    end
  )
  @delete_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:delete_instance),
    defaults["delete_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @set_iam_policy = Google::Gax.create_api_call(
    @instance_admin_stub.method(:set_iam_policy),
    defaults["set_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_iam_policy),
    defaults["get_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @instance_admin_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
end

Class Method Details

.instance_config_path(project, instance_config) ⇒ String

Returns a fully-qualified instance_config resource name string.

Parameters:

  • project (String)
  • instance_config (String)

Returns:

  • (String) 


138
139
140
141
142
143
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 138

def self.instance_config_path project, instance_config
  INSTANCE_CONFIG_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance_config" => instance_config
  )
end

.instance_path(project, instance) ⇒ String

Returns a fully-qualified instance resource name string.

Parameters:

  • project (String)
  • instance (String)

Returns:

  • (String) 


127
128
129
130
131
132
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 127

def self.instance_path project, instance
  INSTANCE_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


148
149
150
151
152
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 148

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#create_instance(parent, instance_id, instance, options: nil) ⇒ Google::Gax::Operation

Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

  • The instance is readable via the API, with all requested attributes but no allocated resources. Its state is CREATING.

Until completion of the returned operation:

  • Cancelling the operation renders the instance immediately unreadable via the API.
    • The instance can be deleted.
    • All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

  • Billing for all successfully-allocated resources begins (some types may have lower than the requested levels).
  • Databases can be created in the instance.
  • The instance's allocated resource levels are readable via the API.
  • The instance's state becomes READY.

The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_parent = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.project_path("[PROJECT]")

# TODO: Initialize `instance_id`:
instance_id = ''

# TODO: Initialize `instance`:
instance = {}

# Register a callback during the method call.
operation = instance_admin_client.create_instance(formatted_parent, instance_id, instance) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • parent (String) —

    Required. The name of the project in which to create the instance. Values are of the form projects/<project>.

  • instance_id (String) —

    Required. The ID of the instance to create. Valid identifiers are of the form [a-z][-a-z0-9]*[a-z0-9] and must be between 2 and 64 characters in length.

  • instance (Google::Spanner::Admin::Instance::V1::Instance | Hash) —

    Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>. A hash of the same form as Google::Spanner::Admin::Instance::V1::Instance can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 656

def create_instance \
    parent,
    instance_id,
    instance,
    options: nil
  req = {
    parent: parent,
    instance_id: instance_id,
    instance: instance
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::CreateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @create_instance.call(req, options),
    @operations_client,
    Google::Spanner::Admin::Instance::V1::Instance,
    Google::Spanner::Admin::Instance::V1::CreateInstanceMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#delete_instance(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes an instance.

Immediately upon completion of the request:

  • Billing ceases for all of the instance's reserved resources.

Soon afterward:

  • The instance and all of its databases immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_name = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
instance_admin_client.delete_instance(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 823

def delete_instance \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::DeleteInstanceRequest)
  @delete_instance.call(req, options, &block)
  nil
end

#get_iam_policy(resource, options_: nil, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Authorization requires spanner.instances.getIamPolicy on resource.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_resource = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = instance_admin_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_ (Google::Iam::V1::GetPolicyOptions | Hash) (defaults to: nil) —

    OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM. A hash of the same form as Google::Iam::V1::GetPolicyOptions can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



911
912
913
914
915
916
917
918
919
920
921
922
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 911

def get_iam_policy \
    resource,
    options_: nil,
    options: nil,
    &block
  req = {
    resource: resource,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
  @get_iam_policy.call(req, options, &block)
end

#get_instance(name, field_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Spanner::Admin::Instance::V1::Instance

Gets information about a particular instance.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_name = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = instance_admin_client.get_instance(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

  • field_mask (Google::Protobuf::FieldMask | Hash) (defaults to: nil) —

    If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 552

def get_instance \
    name,
    field_mask: nil,
    options: nil,
    &block
  req = {
    name: name,
    field_mask: field_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::GetInstanceRequest)
  @get_instance.call(req, options, &block)
end

#get_instance_config(name, options: nil) {|result, operation| ... } ⇒ Google::Spanner::Admin::Instance::V1::InstanceConfig

Gets information about a particular instance configuration.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_name = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_config_path("[PROJECT]", "[INSTANCE_CONFIG]")
response = instance_admin_client.get_instance_config(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



438
439
440
441
442
443
444
445
446
447
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 438

def get_instance_config \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::GetInstanceConfigRequest)
  @get_instance_config.call(req, options, &block)
end

#list_instance_configs(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::InstanceConfig>

Lists the supported instance configurations for a given project.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_parent = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.project_path("[PROJECT]")

# Iterate over all results.
instance_admin_client.list_instance_configs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
instance_admin_client.list_instance_configs(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::InstanceConfig>) —

    An enumerable of Google::Spanner::Admin::Instance::V1::InstanceConfig instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 405

def list_instance_configs \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest)
  @list_instance_configs.call(req, options, &block)
end

#list_instances(parent, page_size: nil, filter: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::Instance>

Lists all instances in the given project.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_parent = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.project_path("[PROJECT]")

# Iterate over all results.
instance_admin_client.list_instances(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
instance_admin_client.list_instances(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • filter (String) (defaults to: nil) —

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • name
      • display_name
      • labels.key where key is the name of a label

    Some examples of using filters are:

    • name:* --> The instance has a name.
    • name:Howl --> The instance's name contains the string "howl".
    • name:HOWL --> Equivalent to above.
    • NAME:howl --> Equivalent to above.
    • labels.env:* --> The instance has the label "env".
    • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
    • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::Instance>) —

    An enumerable of Google::Spanner::Admin::Instance::V1::Instance instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 511

def list_instances \
    parent,
    page_size: nil,
    filter: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size,
    filter: filter
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::ListInstancesRequest)
  @list_instances.call(req, options, &block)
end

#set_iam_policy(resource, policy, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Sets the access control policy on an instance resource. Replaces any existing policy.

Authorization requires spanner.instances.setIamPolicy on resource.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_resource = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize `policy`:
policy = {}
response = instance_admin_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • policy (Google::Iam::V1::Policy | Hash) —

    REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. A hash of the same form as Google::Iam::V1::Policy can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



869
870
871
872
873
874
875
876
877
878
879
880
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 869

def set_iam_policy \
    resource,
    policy,
    options: nil,
    &block
  req = {
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
  @set_iam_policy.call(req, options, &block)
end

#test_iam_permissions(resource, permissions, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that the caller has on the specified instance resource.

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)
formatted_resource = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize `permissions`:
permissions = []
response = instance_admin_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • permissions (Array<String>) —

    The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 957

def test_iam_permissions \
    resource,
    permissions,
    options: nil,
    &block
  req = {
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
  @test_iam_permissions.call(req, options, &block)
end

#update_instance(instance, field_mask, options: nil) ⇒ Google::Gax::Operation

Updates an instance, and begins allocating or releasing resources as requested. The returned [long-running operation][google.longrunning.Operation] can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

  • For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

  • Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a CANCELLED status.
    • All other attempts to modify the instance are rejected.
    • Reading the instance via the API continues to give the pre-request resource levels.

Upon completion of the returned operation:

  • Billing begins for all successfully-allocated resources (some types may have lower than the requested levels).
  • All newly-reserved resources are available for serving the instance's tables.
  • The instance's new resource levels are readable via the API.

The returned long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource name.

Examples:

require "google/cloud/spanner/admin/instance"

instance_admin_client = Google::Cloud::Spanner::Admin::Instance.new(version: :v1)

# TODO: Initialize `instance`:
instance = {}

# TODO: Initialize `field_mask`:
field_mask = {}

# Register a callback during the method call.
operation = instance_admin_client.update_instance(instance, field_mask) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • instance (Google::Spanner::Admin::Instance::V1::Instance | Hash) —

    Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. A hash of the same form as Google::Spanner::Admin::Instance::V1::Instance can also be provided.

  • field_mask (Google::Protobuf::FieldMask | Hash) —

    Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 774

def update_instance \
    instance,
    field_mask,
    options: nil
  req = {
    instance: instance,
    field_mask: field_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::Admin::Instance::V1::UpdateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @update_instance.call(req, options),
    @operations_client,
    Google::Spanner::Admin::Instance::V1::Instance,
    Google::Spanner::Admin::Instance::V1::UpdateInstanceMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end