Class: Google::Apis::PeopleV1::Event

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

An event related to the 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) ⇒ Event

Returns a new instance of Event.



665
666
667
 
# File 'generated/google/apis/people_v1/classes.rb', line 665

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

Instance Attribute Details

#date ⇒ Google::Apis::PeopleV1::Date

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:

  • A full date, with non-zero year, month and day values
  • A month and day value, with a zero year, e.g. an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property date

Returns:



644
645
646
 
# File 'generated/google/apis/people_v1/classes.rb', line 644

def date
  @date
end

#formatted_type ⇒ String

Output only. The type of the event translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale. Corresponds to the JSON property formattedType

Returns:

  • (String) 


650
651
652
 
# File 'generated/google/apis/people_v1/classes.rb', line 650

def formatted_type
  @formatted_type
end

#metadata ⇒ Google::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata

Returns:



655
656
657
 
# File 'generated/google/apis/people_v1/classes.rb', line 655

def metadata
  @metadata
end

#type ⇒ String

The type of the event. The type can be custom or one of these predefined values:

  • anniversary
  • other Corresponds to the JSON property type

Returns:

  • (String) 


663
664
665
 
# File 'generated/google/apis/people_v1/classes.rb', line 663

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



670
671
672
673
674
675
 
# File 'generated/google/apis/people_v1/classes.rb', line 670

def update!(**args)
  @date = args[:date] if args.key?(:date)
  @formatted_type = args[:formatted_type] if args.key?(:formatted_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @type = args[:type] if args.key?(:type)
end