Cloud Spanner API - Class Google::Cloud::Spanner::Status (v2.24.0)

Reference documentation and code samples for the Cloud Spanner API class Google::Cloud::Spanner::Status.

Status

Represents a logical error model from the Spanner service, containing an error code, an error message, and optional error details.

Inherits

  • Object

Example

require "google/cloud/spanner"

spanner = Google::Cloud::Spanner.new

job = spanner.create_database "my-instance",
                              "my-new-database"
job.wait_until_done!

if job.error?
  status = job.error
end

Methods

#code

def code() -> Integer

The status code, which should be an enum value of google.rpc.Code.

Returns
  • (Integer) — the current value of code

#code=

def code=(value) -> Integer

The status code, which should be an enum value of google.rpc.Code.

Parameter
  • value (Integer) — the newly set value
Returns
  • (Integer) — the newly set value

#description

def description() -> String

The human-readable description for the status code, which should be an enum value of google.rpc.Code. For example, INVALID_ARGUMENT.

Returns
  • (String) — the current value of description

#description=

def description=(value) -> String

The human-readable description for the status code, which should be an enum value of google.rpc.Code. For example, INVALID_ARGUMENT.

Parameter
  • value (String) — the newly set value
Returns
  • (String) — the newly set value

#details

def details() -> Array, nil

A list of messages that carry the error details.

Returns
  • (Array, nil) — the current value of details

#details=

def details=(value) -> Array, nil

A list of messages that carry the error details.

Parameter
  • value (Array, nil) — the newly set value
Returns
  • (Array, nil) — the newly set value

#message

def message() -> String

A developer-facing error message, which should be in English.

Returns
  • (String) — the current value of message

#message=

def message=(value) -> String

A developer-facing error message, which should be in English.

Parameter
  • value (String) — the newly set value
Returns
  • (String) — the newly set value