Class: Google::Apis::PeopleV1::PersonResponse

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

Overview

The response for a single person

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) ⇒ PersonResponse

Returns a new instance of PersonResponse



950
951
952
 
# File 'generated/google/apis/people_v1/classes.rb', line 950

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

Instance Attribute Details

#http_status_code ⇒ Fixnum

DEPRECATED(Please use status instead). HTTP 1.1 status code. Corresponds to the JSON property httpStatusCode

Returns:

  • (Fixnum) 


939
940
941
 
# File 'generated/google/apis/people_v1/classes.rb', line 939

def http_status_code
  @http_status_code
end

#person ⇒ Google::Apis::PeopleV1::Person

Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with metadata.primary set to true. Corresponds to the JSON property person

Returns:



889
890
891
 
# File 'generated/google/apis/people_v1/classes.rb', line 889

def person
  @person
end

#requested_resource_name ⇒ String

The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL. Corresponds to the JSON property requestedResourceName

Returns:

  • (String) 


948
949
950
 
# File 'generated/google/apis/people_v1/classes.rb', line 948

def requested_resource_name
  @requested_resource_name
end

#status ⇒ Google::Apis::PeopleV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

  • Simple to use and understand for most users
  • Flexible enough to meet unexpected needs # Overview The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions. # Language mapping The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include:
  • Partial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.
  • Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.
  • Batch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.
  • Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.
  • Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons. Corresponds to the JSON property status

Returns:



932
933
934
 
# File 'generated/google/apis/people_v1/classes.rb', line 932

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



955
956
957
958
959
960
 
# File 'generated/google/apis/people_v1/classes.rb', line 955

def update!(**args)
  @person = args[:person] if args.key?(:person)
  @status = args[:status] if args.key?(:status)
  @http_status_code = args[:http_status_code] if args.key?(:http_status_code)
  @requested_resource_name = args[:requested_resource_name] if args.key?(:requested_resource_name)
end