Class: Google::Apis::JobsV3p1beta1::Company

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

Overview

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

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

Returns a new instance of Company



425
426
427
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 425

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

Instance Attribute Details

#career_site_uri ⇒ String

Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". Corresponds to the JSON property careerSiteUri

Returns:

  • (String) 


329
330
331
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 329

def career_site_uri
  @career_site_uri
end

#derived_info ⇒ Google::Apis::JobsV3p1beta1::CompanyDerivedInfo

Derived details about the company. Corresponds to the JSON property derivedInfo

Returns:



334
335
336
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 334

def derived_info
  @derived_info
end

#display_name ⇒ String

Required. The display name of the company, for example, "Google, LLC". Corresponds to the JSON property displayName

Returns:

  • (String) 


340
341
342
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 340

def display_name
  @display_name
end

#eeo_text ⇒ String

Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. Corresponds to the JSON property eeoText

Returns:

  • (String) 


349
350
351
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 349

def eeo_text
  @eeo_text
end

#external_id ⇒ String

Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. Corresponds to the JSON property externalId

Returns:

  • (String) 


357
358
359
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 357

def external_id
  @external_id
end

#headquarters_address ⇒ String

Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. Corresponds to the JSON property headquartersAddress

Returns:

  • (String) 


366
367
368
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 366

def headquarters_address
  @headquarters_address
end

#hiring_agency ⇒ Boolean Also known as: hiring_agency?

Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. Corresponds to the JSON property hiringAgency

Returns:

  • (Boolean) 


374
375
376
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 374

def hiring_agency
  @hiring_agency
end

#image_uri ⇒ String

Optional. A URI that hosts the employer's company logo. Corresponds to the JSON property imageUri

Returns:

  • (String) 


381
382
383
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 381

def image_uri
  @image_uri
end

#keyword_searchable_job_custom_attributes ⇒ Array<String>

Optional. A list of keys of filterable Job.custom_attributes, whose corresponding string_values are used in keyword search. Jobs with string_values under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. Corresponds to the JSON property keywordSearchableJobCustomAttributes

Returns:

  • (Array<String>) 


392
393
394
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 392

def keyword_searchable_job_custom_attributes
  @keyword_searchable_job_custom_attributes
end

#name ⇒ String

Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/project_id/companies/company_id", for example, "projects/api-test-project/companies/foo". Corresponds to the JSON property name

Returns:

  • (String) 


401
402
403
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 401

def name
  @name
end

#size ⇒ String

Optional. The employer's company size. Corresponds to the JSON property size

Returns:

  • (String) 


407
408
409
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 407

def size
  @size
end

#suspended ⇒ Boolean Also known as: suspended?

Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. Corresponds to the JSON property suspended

Returns:

  • (Boolean) 


414
415
416
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 414

def suspended
  @suspended
end

#website_uri ⇒ String

Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. Corresponds to the JSON property websiteUri

Returns:

  • (String) 


423
424
425
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 423

def website_uri
  @website_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 430

def update!(**args)
  @career_site_uri = args[:career_site_uri] if args.key?(:career_site_uri)
  @derived_info = args[:derived_info] if args.key?(:derived_info)
  @display_name = args[:display_name] if args.key?(:display_name)
  @eeo_text = args[:eeo_text] if args.key?(:eeo_text)
  @external_id = args[:external_id] if args.key?(:external_id)
  @headquarters_address = args[:headquarters_address] if args.key?(:headquarters_address)
  @hiring_agency = args[:hiring_agency] if args.key?(:hiring_agency)
  @image_uri = args[:image_uri] if args.key?(:image_uri)
  @keyword_searchable_job_custom_attributes = args[:keyword_searchable_job_custom_attributes] if args.key?(:keyword_searchable_job_custom_attributes)
  @name = args[:name] if args.key?(:name)
  @size = args[:size] if args.key?(:size)
  @suspended = args[:suspended] if args.key?(:suspended)
  @website_uri = args[:website_uri] if args.key?(:website_uri)
end