Class: Google::Apis::FirebaseV1beta1::StatusProto

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/firebase_v1beta1/classes.rb,
generated/google/apis/firebase_v1beta1/representations.rb,
generated/google/apis/firebase_v1beta1/representations.rb

Overview

Wire-format for a Status object

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ StatusProto

Returns a new instance of StatusProto.



1129
1130
1131
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1129

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#canonical_code ⇒ Fixnum

The canonical error code (see codes.proto) that most closely corresponds to this status. May be missing. Corresponds to the JSON property canonicalCode

Returns:

  • (Fixnum) 


1087
1088
1089
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1087

def canonical_code
  @canonical_code
end

#code ⇒ Fixnum

Numeric code drawn from the space specified below. Often, this is the canonical error space, and code is drawn from google3/util/task/codes.proto Corresponds to the JSON property code

Returns:

  • (Fixnum) 


1093
1094
1095
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1093

def code
  @code
end

#message ⇒ String

Detail message Corresponds to the JSON property message

Returns:

  • (String) 


1098
1099
1100
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1098

def message
  @message
end

#message_set ⇒ Google::Apis::FirebaseV1beta1::MessageSet

This is proto2's version of MessageSet. Corresponds to the JSON property messageSet

Returns:



1103
1104
1105
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1103

def message_set
  @message_set
end

#payload ⇒ Google::Apis::FirebaseV1beta1::TypedMessage

Message that groups a protocol type_id (as defined by MessageSet), with an encoded message of that type. Its use is similar to MessageSet, except it represents a single (type, encoded message) instead of a set. To fill for known protocol type: MyProtocolMsg proto; TypedMessage typed_msg; typed_msg.set_type_id(MyProtocolMsg::MESSAGE_TYPE_ID); proto.AppendToCord(typed_msg.mutable_message()); To fill for unknown protocol type: ProtocolMessage proto; TypedMessage typed_msg; typed_msg.set_type_id(proto.GetMapper()->type_id()); proto.AppendToCord(typed_msg.mutable_message()); Corresponds to the JSON property payload

Returns:



1121
1122
1123
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1121

def payload
  @payload
end

#space ⇒ String

The following are usually only present when code != 0 Space to which this status belongs Corresponds to the JSON property space

Returns:

  • (String) 


1127
1128
1129
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1127

def space
  @space
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'generated/google/apis/firebase_v1beta1/classes.rb', line 1134

def update!(**args)
  @canonical_code = args[:canonical_code] if args.key?(:canonical_code)
  @code = args[:code] if args.key?(:code)
  @message = args[:message] if args.key?(:message)
  @message_set = args[:message_set] if args.key?(:message_set)
  @payload = args[:payload] if args.key?(:payload)
  @space = args[:space] if args.key?(:space)
end