Class: Google::Apis::PeopleV1::Organization

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

A person's past or current organization. Overlapping date ranges are permitted.

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

Returns a new instance of Organization



1305
1306
1307
# File 'generated/google/apis/people_v1/classes.rb', line 1305

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

Instance Attribute Details

#currentBoolean Also known as: current?

True if the organization is the person's current organization; false if the organization is a past organization. Corresponds to the JSON property current

Returns:

  • (Boolean)


1217
1218
1219
# File 'generated/google/apis/people_v1/classes.rb', line 1217

def current
  @current
end

#departmentString

The person's department at the organization. Corresponds to the JSON property department

Returns:

  • (String)


1223
1224
1225
# File 'generated/google/apis/people_v1/classes.rb', line 1223

def department
  @department
end

#domainString

The domain name associated with the organization; for example, google.com. Corresponds to the JSON property domain

Returns:

  • (String)


1229
1230
1231
# File 'generated/google/apis/people_v1/classes.rb', line 1229

def domain
  @domain
end

#end_dateGoogle::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 endDate


1241
1242
1243
# File 'generated/google/apis/people_v1/classes.rb', line 1241

def end_date
  @end_date
end

#formatted_typeString

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

Returns:

  • (String)


1247
1248
1249
# File 'generated/google/apis/people_v1/classes.rb', line 1247

def formatted_type
  @formatted_type
end

#job_descriptionString

The person's job description at the organization. Corresponds to the JSON property jobDescription

Returns:

  • (String)


1252
1253
1254
# File 'generated/google/apis/people_v1/classes.rb', line 1252

def job_description
  @job_description
end

#locationString

The location of the organization office the person works at. Corresponds to the JSON property location

Returns:

  • (String)


1257
1258
1259
# File 'generated/google/apis/people_v1/classes.rb', line 1257

def location
  @location
end

#metadataGoogle::Apis::PeopleV1::FieldMetadata

Metadata about a field. Corresponds to the JSON property metadata



1262
1263
1264
# File 'generated/google/apis/people_v1/classes.rb', line 1262

def 
  @metadata
end

#nameString

The name of the organization. Corresponds to the JSON property name

Returns:

  • (String)


1267
1268
1269
# File 'generated/google/apis/people_v1/classes.rb', line 1267

def name
  @name
end

#phonetic_nameString

The phonetic name of the organization. Corresponds to the JSON property phoneticName

Returns:

  • (String)


1272
1273
1274
# File 'generated/google/apis/people_v1/classes.rb', line 1272

def phonetic_name
  @phonetic_name
end

#start_dateGoogle::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 startDate


1284
1285
1286
# File 'generated/google/apis/people_v1/classes.rb', line 1284

def start_date
  @start_date
end

#symbolString

The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym. Corresponds to the JSON property symbol

Returns:

  • (String)


1290
1291
1292
# File 'generated/google/apis/people_v1/classes.rb', line 1290

def symbol
  @symbol
end

#titleString

The person's job title at the organization. Corresponds to the JSON property title

Returns:

  • (String)


1295
1296
1297
# File 'generated/google/apis/people_v1/classes.rb', line 1295

def title
  @title
end

#typeString

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

  • work
  • school Corresponds to the JSON property type

Returns:

  • (String)


1303
1304
1305
# File 'generated/google/apis/people_v1/classes.rb', line 1303

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
# File 'generated/google/apis/people_v1/classes.rb', line 1310

def update!(**args)
  @current = args[:current] if args.key?(:current)
  @department = args[:department] if args.key?(:department)
  @domain = args[:domain] if args.key?(:domain)
  @end_date = args[:end_date] if args.key?(:end_date)
  @formatted_type = args[:formatted_type] if args.key?(:formatted_type)
  @job_description = args[:job_description] if args.key?(:job_description)
  @location = args[:location] if args.key?(:location)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @phonetic_name = args[:phonetic_name] if args.key?(:phonetic_name)
  @start_date = args[:start_date] if args.key?(:start_date)
  @symbol = args[:symbol] if args.key?(:symbol)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end