Class: Google::Apis::JobsV3::Company

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3/classes.rb,
generated/google/apis/jobs_v3/representations.rb,
generated/google/apis/jobs_v3/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

Constructor Details

#initialize(**args) ⇒ Company

Returns a new instance of Company.



385
386
387
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 385

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) 


302
303
304
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 302

def career_site_uri
  @career_site_uri
end

#derived_info ⇒ Google::Apis::JobsV3::CompanyDerivedInfo

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

Returns:



307
308
309
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 307

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) 


312
313
314
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 312

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) 


319
320
321
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 319

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) 


325
326
327
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 325

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) 


333
334
335
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 333

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) 


339
340
341
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 339

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) 


345
346
347
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 345

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


355
356
357
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 355

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) 


363
364
365
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 363

def name
  @name
end

#size ⇒ String

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

Returns:

  • (String) 


368
369
370
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 368

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) 


375
376
377
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 375

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) 


383
384
385
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 383

def website_uri
  @website_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'generated/google/apis/jobs_v3/classes.rb', line 390

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