generated/google/apis/jobs_v3/classes.rb in google-api-client-0.44.1 vs generated/google/apis/jobs_v3/classes.rb in google-api-client-0.44.2

- old
+ new

@@ -24,38 +24,30 @@ # Application related details of a job posting. class ApplicationInfo include Google::Apis::Core::Hashable - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to specify email address(es) to which resumes or - # applications can be sent. - # The maximum number of allowed characters for each entry is 255. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to specify email address(es) to which resumes or applications + # can be sent. The maximum number of allowed characters for each entry is 255. # Corresponds to the JSON property `emails` # @return [Array<String>] attr_accessor :emails - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this field to provide instructions, such as "Mail your application - # to ...", that a candidate can follow to apply for the job. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 3,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this field to provide instructions, such as "Mail your application to ...", + # that a candidate can follow to apply for the job. This field accepts and + # sanitizes HTML input, and also accepts bold, italic, ordered list, and + # unordered list markup tags. The maximum number of allowed characters is 3,000. # Corresponds to the JSON property `instruction` # @return [String] attr_accessor :instruction - # Optional but at least one of uris, - # emails or instruction must be - # specified. - # Use this URI field to direct an applicant to a website, for example to - # link to an online application form. - # The maximum number of allowed characters for each entry is 2,000. + # Optional but at least one of uris, emails or instruction must be specified. + # Use this URI field to direct an applicant to a website, for example to link to + # an online application form. The maximum number of allowed characters for each + # entry is 2,000. # Corresponds to the JSON property `uris` # @return [Array<String>] attr_accessor :uris def initialize(**args) @@ -68,22 +60,18 @@ @instruction = args[:instruction] if args.key?(:instruction) @uris = args[:uris] if args.key?(:uris) end end - # Input only. - # Batch delete jobs request. + # Input only. Batch delete jobs request. class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. The filter string specifies the jobs to be deleted. - # Supported operator: =, AND - # The fields eligible for filtering are: - # * `companyName` (Required) - # * `requisitionId` (Required) - # Sample Query: companyName = "projects/api-test-project/companies/123" AND - # requisitionId = "req-1" + # Required. The filter string specifies the jobs to be deleted. Supported + # operator: =, AND The fields eligible for filtering are: * `companyName` ( + # Required) * `requisitionId` (Required) Sample Query: companyName = "projects/ + # api-test-project/companies/123" AND requisitionId = "req-1" # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter def initialize(**args) @@ -146,35 +134,32 @@ end end # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. class ClientEvent include Google::Apis::Core::Hashable # Required. The timestamp of the event. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Required. A unique identifier, generated by the client application. This ` - # event_id` - # is used to establish the relationship between different events - # (see parent_event_id). + # event_id` is used to establish the relationship between different events (see + # parent_event_id). # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id # Optional. Extra information about this event. Used for storing information - # with no - # matching field in event payload, for example, user application specific - # context or details. - # At most 20 keys are supported. The maximum total size of all keys and - # values is 2 KB. + # with no matching field in event payload, for example, user application + # specific context or details. At most 20 keys are supported. The maximum total + # size of all keys and values is 2 KB. # Corresponds to the JSON property `extraInfo` # @return [Hash<String,String>] attr_accessor :extra_info # An event issued when a job seeker interacts with the application that @@ -182,17 +167,14 @@ # Corresponds to the JSON property `jobEvent` # @return [Google::Apis::JobsV3::JobEvent] attr_accessor :job_event # Optional. The event_id of an event that resulted in the current event. For - # example, a - # Job view event usually follows a parent - # impression event: A job seeker first does a - # search where a list of jobs appears - # (impression). The job seeker then selects a - # result and views the description of a particular job (Job - # view). + # example, a Job view event usually follows a parent impression event: A job + # seeker first does a search where a list of jobs appears (impression). The job + # seeker then selects a result and views the description of a particular job ( + # Job view). # Corresponds to the JSON property `parentEventId` # @return [String] attr_accessor :parent_event_id # Required. A unique ID generated in the API responses. It can be found in @@ -214,37 +196,34 @@ @parent_event_id = args[:parent_event_id] if args.key?(:parent_event_id) @request_id = args[:request_id] if args.key?(:request_id) end end - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. class CommuteFilter include Google::Apis::Core::Hashable # Optional. If true, jobs without "precise" addresses (street level addresses or - # GPS - # coordinates) might also be returned. For city and coarser level addresses, - # text matching is used. If this field is set to false or is not specified, - # only jobs that include precise addresses are returned by Commute - # Search. - # Note: If `allow_imprecise_addresses` is set to true, Commute Search is not - # able to calculate accurate commute times to jobs with city level and - # coarser address information. Jobs with imprecise addresses will return a - # `travel_duration` time of 0 regardless of distance from the job seeker. + # GPS coordinates) might also be returned. For city and coarser level addresses, + # text matching is used. If this field is set to false or is not specified, only + # jobs that include precise addresses are returned by Commute Search. Note: If ` + # allow_imprecise_addresses` is set to true, Commute Search is not able to + # calculate accurate commute times to jobs with city level and coarser address + # information. Jobs with imprecise addresses will return a `travel_duration` + # time of 0 regardless of distance from the job seeker. # Corresponds to the JSON property `allowImpreciseAddresses` # @return [Boolean] attr_accessor :allow_imprecise_addresses alias_method :allow_imprecise_addresses?, :allow_imprecise_addresses # Required. The method of transportation for which to calculate the commute time. # Corresponds to the JSON property `commuteMethod` # @return [String] attr_accessor :commute_method - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. # Corresponds to the JSON property `departureTime` # @return [Google::Apis::JobsV3::TimeOfDay] attr_accessor :departure_time @@ -253,20 +232,18 @@ # @return [String] attr_accessor :road_traffic # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - # standard</a>. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `startCoordinates` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :start_coordinates # Required. The maximum travel time in seconds. The maximum allowed value is ` - # 3600s` - # (one hour). Format is `123s`. + # 3600s` (one hour). Format is `123s`. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration def initialize(**args) @@ -282,25 +259,23 @@ @start_coordinates = args[:start_coordinates] if args.key?(:start_coordinates) @travel_duration = args[:travel_duration] if args.key?(:travel_duration) end end - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. class CommuteInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `jobLocation` # @return [Google::Apis::JobsV3::Location] attr_accessor :job_location - # The number of seconds required to travel to the job location from the - # query location. A duration of 0 seconds indicates that the job is not - # reachable within the requested duration, but was returned as part of an - # expanded query. + # The number of seconds required to travel to the job location from the query + # location. A duration of 0 seconds indicates that the job is not reachable + # within the requested duration, but was returned as part of an expanded query. # Corresponds to the JSON property `travelDuration` # @return [String] attr_accessor :travel_duration def initialize(**args) @@ -319,12 +294,11 @@ # employing applicants for the job position. class Company include Google::Apis::Core::Hashable # Optional. The URI to employer's career site or careers page on the employer's - # web - # site, for example, "https://careers.google.com". + # web site, for example, "https://careers.google.com". # Corresponds to the JSON property `careerSiteUri` # @return [String] attr_accessor :career_site_uri # Derived details about the company. @@ -335,36 +309,33 @@ # Required. The display name of the company, for example, "Google LLC". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # 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. + # 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` # @return [String] attr_accessor :eeo_text # Required. Client side company identifier, used to uniquely identify the - # company. - # The maximum number of allowed characters is 255. + # company. The maximum number of allowed characters is 255. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id # 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. + # 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` # @return [String] attr_accessor :headquarters_address # Optional. Set to true if it is the hiring agency that post jobs for other - # employers. - # Defaults to false if not provided. + # employers. Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` # @return [Boolean] attr_accessor :hiring_agency alias_method :hiring_agency?, :hiring_agency @@ -372,24 +343,23 @@ # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri # 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. + # 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` # @return [Array<String>] attr_accessor :keyword_searchable_job_custom_attributes - # 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". + # 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` # @return [String] attr_accessor :name # Optional. The employer's company size. @@ -404,12 +374,12 @@ # @return [Boolean] attr_accessor :suspended alias_method :suspended?, :suspended # 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. + # for example, "https://www.google.com". The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `websiteUri` # @return [String] attr_accessor :website_uri def initialize(**args) @@ -436,12 +406,12 @@ # Derived details about the company. class CompanyDerivedInfo include Google::Apis::Core::Hashable - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. # Corresponds to the JSON property `headquartersLocation` # @return [Google::Apis::JobsV3::Location] attr_accessor :headquarters_location def initialize(**args) @@ -452,57 +422,50 @@ def update!(**args) @headquarters_location = args[:headquarters_location] if args.key?(:headquarters_location) end end - # A compensation entry that represents one component of compensation, such - # as base pay, bonus, or other compensation type. - # Annualization: One compensation entry can be annualized if - # - it contains valid amount or range. - # - and its expected_units_per_year is set or can be derived. - # Its annualized range is determined as (amount or range) times - # expected_units_per_year. + # A compensation entry that represents one component of compensation, such as + # base pay, bonus, or other compensation type. Annualization: One compensation + # entry can be annualized if - it contains valid amount or range. - and its + # expected_units_per_year is set or can be derived. Its annualized range is + # determined as (amount or range) times expected_units_per_year. class CompensationEntry include Google::Apis::Core::Hashable # Represents an amount of money with its currency type. # Corresponds to the JSON property `amount` # @return [Google::Apis::JobsV3::Money] attr_accessor :amount - # Optional. Compensation description. For example, could - # indicate equity terms or provide additional context to an estimated - # bonus. + # Optional. Compensation description. For example, could indicate equity terms + # or provide additional context to an estimated bonus. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Expected number of units paid each year. If not specified, when - # Job.employment_types is FULLTIME, a default value is inferred - # based on unit. Default values: - # - HOURLY: 2080 - # - DAILY: 260 - # - WEEKLY: 52 - # - MONTHLY: 12 - # - ANNUAL: 1 + # Optional. Expected number of units paid each year. If not specified, when Job. + # employment_types is FULLTIME, a default value is inferred based on unit. + # Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - + # ANNUAL: 1 # Corresponds to the JSON property `expectedUnitsPerYear` # @return [Float] attr_accessor :expected_units_per_year # Compensation range. # Corresponds to the JSON property `range` # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :range - # Optional. Compensation type. - # Default is CompensationUnit.COMPENSATION_TYPE_UNSPECIFIED. + # Optional. Compensation type. Default is CompensationUnit. + # COMPENSATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. - # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + # Optional. Frequency of the specified amount. Default is CompensationUnit. + # COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit def initialize(**args) @@ -518,12 +481,11 @@ @type = args[:type] if args.key?(:type) @unit = args[:unit] if args.key?(:unit) end end - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. class CompensationFilter include Google::Apis::Core::Hashable # Optional. If set to true, jobs with unspecified compensation range fields are # included. @@ -540,12 +502,12 @@ # Required. Type of filter. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Required. Specify desired `base compensation entry's` - # CompensationInfo.CompensationUnit. + # Required. Specify desired `base compensation entry's` CompensationInfo. + # CompensationUnit. # Corresponds to the JSON property `units` # @return [Array<String>] attr_accessor :units def initialize(**args) @@ -559,25 +521,23 @@ @type = args[:type] if args.key?(:type) @units = args[:units] if args.key?(:units) end end - # Input only. - # Compensation based histogram request. + # Input only. Compensation based histogram request. class CompensationHistogramRequest include Google::Apis::Core::Hashable - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `bucketingOption` # @return [Google::Apis::JobsV3::NumericBucketingOption] attr_accessor :bucketing_option # Required. Type of the request, representing which field the histogramming - # should be - # performed over. A single request can only specify one histogram of each - # `CompensationHistogramRequestType`. + # should be performed over. A single request can only specify one histogram of + # each `CompensationHistogramRequestType`. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -589,23 +549,20 @@ @bucketing_option = args[:bucketing_option] if args.key?(:bucketing_option) @type = args[:type] if args.key?(:type) end end - # Output only. - # Compensation based histogram result. + # Output only. Compensation based histogram result. class CompensationHistogramResult include Google::Apis::Core::Hashable - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `result` # @return [Google::Apis::JobsV3::NumericBucketingResult] attr_accessor :result - # Type of the request, corresponding to - # CompensationHistogramRequest.type. + # Type of the request, corresponding to CompensationHistogramRequest.type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type def initialize(**args) @@ -631,14 +588,13 @@ # Compensation range. # Corresponds to the JSON property `annualizedTotalCompensationRange` # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. Job compensation information. - # At most one entry can be of type - # CompensationInfo.CompensationType.BASE, which is - # referred as ** base compensation entry ** for the job. + # Optional. Job compensation information. At most one entry can be of type + # CompensationInfo.CompensationType.BASE, which is referred as ** base + # compensation entry ** for the job. # Corresponds to the JSON property `entries` # @return [Array<Google::Apis::JobsV3::CompensationEntry>] attr_accessor :entries def initialize(**args) @@ -676,22 +632,21 @@ @max_compensation = args[:max_compensation] if args.key?(:max_compensation) @min_compensation = args[:min_compensation] if args.key?(:min_compensation) end end - # Output only. - # Response of auto-complete query. + # Output only. Response of auto-complete query. class CompleteQueryResponse include Google::Apis::Core::Hashable # Results of the matching job/company candidates. # Corresponds to the JSON property `completionResults` # @return [Array<Google::Apis::JobsV3::CompletionResult>] attr_accessor :completion_results - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata def initialize(**args) @@ -703,12 +658,11 @@ @completion_results = args[:completion_results] if args.key?(:completion_results) @metadata = args[:metadata] if args.key?(:metadata) end end - # Output only. - # Resource that represents completion results. + # Output only. Resource that represents completion results. class CompletionResult include Google::Apis::Core::Hashable # The URI of the company image for CompletionType.COMPANY_NAME. # Corresponds to the JSON property `imageUri` @@ -741,13 +695,13 @@ class CreateClientEventRequest include Google::Apis::Core::Hashable # An event issued when an end user interacts with the application that # implements Cloud Talent Solution. Providing this information improves the - # quality of search and recommendation for the API clients, enabling the - # service to perform optimally. The number of events sent must be consistent - # with other calls, such as job searches, issued to the service by the client. + # quality of search and recommendation for the API clients, enabling the service + # to perform optimally. The number of events sent must be consistent with other + # calls, such as job searches, issued to the service by the client. # Corresponds to the JSON property `clientEvent` # @return [Google::Apis::JobsV3::ClientEvent] attr_accessor :client_event def initialize(**args) @@ -758,12 +712,11 @@ def update!(**args) @client_event = args[:client_event] if args.key?(:client_event) end end - # Input only. - # The Request of the CreateCompany method. + # Input only. The Request of the CreateCompany method. class CreateCompanyRequest include Google::Apis::Core::Hashable # 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 @@ -780,18 +733,17 @@ def update!(**args) @company = args[:company] if args.key?(:company) end end - # Input only. - # Create job request. + # Input only. Create job request. class CreateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job def initialize(**args) @@ -807,37 +759,31 @@ # Custom attribute values that are either filterable or non-filterable. class CustomAttribute include Google::Apis::Core::Hashable # Optional. If the `filterable` flag is true, the custom field values may be - # used for - # custom attribute filters JobQuery.custom_attribute_filter. - # If false, these values may not be used for custom attribute filters. - # Default is false. + # used for custom attribute filters JobQuery.custom_attribute_filter. If false, + # these values may not be used for custom attribute filters. Default is false. # Corresponds to the JSON property `filterable` # @return [Boolean] attr_accessor :filterable alias_method :filterable?, :filterable - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform number range search. - # (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. - # Currently at most 1 long_values is supported. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, ` + # LT`) over filterable `long_value`. Currently at most 1 long_values is + # supported. # Corresponds to the JSON property `longValues` # @return [Array<Fixnum>] attr_accessor :long_values - # Optional but exactly one of string_values or long_values must - # be specified. - # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or - # `CASE_INSENSITIVE_MATCH`) search. - # For filterable `string_value`s, a maximum total number of 200 values - # is allowed, with each `string_value` has a byte size of no more than - # 500B. For unfilterable `string_values`, the maximum total byte size of - # unfilterable `string_values` is 50KB. - # Empty string is not allowed. + # Optional but exactly one of string_values or long_values must be specified. + # This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or ` + # CASE_INSENSITIVE_MATCH`) search. For filterable `string_value`s, a maximum + # total number of 200 values is allowed, with each `string_value` has a byte + # size of no more than 500B. For unfilterable `string_values`, the maximum total + # byte size of unfilterable `string_values` is 50KB. Empty string is not allowed. # Corresponds to the JSON property `stringValues` # @return [Array<String>] attr_accessor :string_values def initialize(**args) @@ -851,32 +797,31 @@ @string_values = args[:string_values] if args.key?(:string_values) end end # Custom attributes histogram request. An error is thrown if neither - # string_value_histogram or long_value_histogram_bucketing_option has - # been defined. + # string_value_histogram or long_value_histogram_bucketing_option has been + # defined. class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable # Required. Specifies the custom field key to perform a histogram on. If - # specified - # without `long_value_histogram_bucketing_option`, histogram on string values - # of the given `key` is triggered, otherwise histogram is performed on long - # values. + # specified without `long_value_histogram_bucketing_option`, histogram on string + # values of the given `key` is triggered, otherwise histogram is performed on + # long values. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. # Corresponds to the JSON property `longValueHistogramBucketingOption` # @return [Google::Apis::JobsV3::NumericBucketingOption] attr_accessor :long_value_histogram_bucketing_option - # Optional. If set to true, the response includes the histogram value for - # each key as a string. + # Optional. If set to true, the response includes the histogram value for each + # key as a string. # Corresponds to the JSON property `stringValueHistogram` # @return [Boolean] attr_accessor :string_value_histogram alias_method :string_value_histogram?, :string_value_histogram @@ -890,28 +835,26 @@ @long_value_histogram_bucketing_option = args[:long_value_histogram_bucketing_option] if args.key?(:long_value_histogram_bucketing_option) @string_value_histogram = args[:string_value_histogram] if args.key?(:string_value_histogram) end end - # Output only. - # Custom attribute histogram result. + # Output only. Custom attribute histogram result. class CustomAttributeHistogramResult include Google::Apis::Core::Hashable # Stores the key of custom attribute the histogram is performed on. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. # Corresponds to the JSON property `longValueHistogramResult` # @return [Google::Apis::JobsV3::NumericBucketingResult] attr_accessor :long_value_histogram_result - # Stores a map from the values of string custom field associated - # with `key` to the number of jobs with that value in this histogram result. + # Stores a map from the values of string custom field associated with `key` to + # the number of jobs with that value in this histogram result. # Corresponds to the JSON property `stringValueHistogramResult` # @return [Hash<String,Fixnum>] attr_accessor :string_value_histogram_result def initialize(**args) @@ -924,13 +867,13 @@ @long_value_histogram_result = args[:long_value_histogram_result] if args.key?(:long_value_histogram_result) @string_value_histogram_result = args[:string_value_histogram_result] if args.key?(:string_value_histogram_result) end end - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. class DeviceInfo include Google::Apis::Core::Hashable # Optional. Type of the device. # Corresponds to the JSON property `deviceType` @@ -952,17 +895,15 @@ @device_type = args[:device_type] if args.key?(:device_type) @id = args[:id] if args.key?(:id) end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) @@ -971,30 +912,28 @@ # Update properties of this object def update!(**args) end end - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. class HistogramFacets include Google::Apis::Core::Hashable - # Optional. Specifies compensation field-based histogram requests. - # Duplicate values of CompensationHistogramRequest.type are not allowed. + # Optional. Specifies compensation field-based histogram requests. Duplicate + # values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array<Google::Apis::JobsV3::CompensationHistogramRequest>] attr_accessor :compensation_histogram_facets - # Optional. Specifies the custom attributes histogram requests. - # Duplicate values of CustomAttributeHistogramRequest.key are not - # allowed. + # Optional. Specifies the custom attributes histogram requests. Duplicate values + # of CustomAttributeHistogramRequest.key are not allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array<Google::Apis::JobsV3::CustomAttributeHistogramRequest>] attr_accessor :custom_attribute_histogram_facets - # Optional. Specifies the simple type of histogram facets, for example, - # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. + # Optional. Specifies the simple type of histogram facets, for example, ` + # COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array<String>] attr_accessor :simple_histogram_facets def initialize(**args) @@ -1007,26 +946,23 @@ @custom_attribute_histogram_facets = args[:custom_attribute_histogram_facets] if args.key?(:custom_attribute_histogram_facets) @simple_histogram_facets = args[:simple_histogram_facets] if args.key?(:simple_histogram_facets) end end - # Output only. - # Result of a histogram call. The response contains the histogram map for the - # search type specified by HistogramResult.field. - # The response is a map of each filter value to the corresponding count of - # jobs for that filter. + # Output only. Result of a histogram call. The response contains the histogram + # map for the search type specified by HistogramResult.field. The response is a + # map of each filter value to the corresponding count of jobs for that filter. class HistogramResult include Google::Apis::Core::Hashable # The Histogram search filters. # Corresponds to the JSON property `searchType` # @return [String] attr_accessor :search_type - # A map from the values of field to the number of jobs with that value - # in this search result. - # Key: search type (filter names, such as the companyName). + # A map from the values of field to the number of jobs with that value in this + # search result. Key: search type (filter names, such as the companyName). # Values: the count of jobs that match the filter for this search. # Corresponds to the JSON property `values` # @return [Hash<String,Fixnum>] attr_accessor :values @@ -1039,30 +975,29 @@ @search_type = args[:search_type] if args.key?(:search_type) @values = args[:values] if args.key?(:values) end end - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. class HistogramResults include Google::Apis::Core::Hashable # Specifies compensation field-based histogram results that match # HistogramFacets.compensation_histogram_requests. # Corresponds to the JSON property `compensationHistogramResults` # @return [Array<Google::Apis::JobsV3::CompensationHistogramResult>] attr_accessor :compensation_histogram_results - # Specifies histogram results for custom attributes that match - # HistogramFacets.custom_attribute_histogram_facets. + # Specifies histogram results for custom attributes that match HistogramFacets. + # custom_attribute_histogram_facets. # Corresponds to the JSON property `customAttributeHistogramResults` # @return [Array<Google::Apis::JobsV3::CustomAttributeHistogramResult>] attr_accessor :custom_attribute_histogram_results - # Specifies histogram results that matches - # HistogramFacets.simple_histogram_facets. + # Specifies histogram results that matches HistogramFacets. + # simple_histogram_facets. # Corresponds to the JSON property `simpleHistogramResults` # @return [Array<Google::Apis::JobsV3::HistogramResult>] attr_accessor :simple_histogram_results def initialize(**args) @@ -1076,28 +1011,26 @@ @simple_histogram_results = args[:simple_histogram_results] if args.key?(:simple_histogram_results) end end # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. class Job include Google::Apis::Core::Hashable - # Optional but strongly recommended for the best service experience. - # Location(s) where the employer is looking to hire for this job posting. - # Specifying the full street address(es) of the hiring location enables - # better API results, especially job searches by commute time. - # At most 50 locations are allowed for best search performance. If a job has - # more locations, it is suggested to split it into multiple jobs with unique - # requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as - # multiple jobs with the same company_name, language_code and - # requisition_id are not allowed. If the original requisition_id must - # be preserved, a custom field should be used for storage. It is also - # suggested to group the locations that close to each other in the same job - # for better search experience. - # The maximum number of allowed characters is 500. + # Optional but strongly recommended for the best service experience. Location(s) + # where the employer is looking to hire for this job posting. Specifying the + # full street address(es) of the hiring location enables better API results, + # especially job searches by commute time. At most 50 locations are allowed for + # best search performance. If a job has more locations, it is suggested to split + # it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1' + # , 'ReqA-2', etc.) as multiple jobs with the same company_name, language_code + # and requisition_id are not allowed. If the original requisition_id must be + # preserved, a custom field should be used for storage. It is also suggested to + # group the locations that close to each other in the same job for better search + # experience. The maximum number of allowed characters is 500. # Corresponds to the JSON property `addresses` # @return [Array<String>] attr_accessor :addresses # Application related details of a job posting. @@ -1108,32 +1041,29 @@ # Output only. Display name of the company listing the job. # Corresponds to the JSON property `companyDisplayName` # @return [String] attr_accessor :company_display_name - # Required. The resource name of the company listing the job, such as - # "projects/api-test-project/companies/foo". + # Required. The resource name of the company listing the job, such as "projects/ + # api-test-project/companies/foo". # Corresponds to the JSON property `companyName` # @return [String] attr_accessor :company_name # Job compensation details. # Corresponds to the JSON property `compensationInfo` # @return [Google::Apis::JobsV3::CompensationInfo] attr_accessor :compensation_info # Optional. A map of fields to hold both filterable and non-filterable custom - # job - # attributes that are not covered by the provided structured fields. - # The keys of the map are strings up to 64 bytes and must match the - # pattern: a-zA-Z*. For example, key0LikeThis or - # KEY_1_LIKE_THIS. - # At most 100 filterable and at most 100 unfilterable keys are supported. - # For filterable `string_values`, across all keys at most 200 values are - # allowed, with each string no more than 255 characters. For unfilterable - # `string_values`, the maximum total size of `string_values` across all keys - # is 50KB. + # job attributes that are not covered by the provided structured fields. The + # keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. + # For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at + # most 100 unfilterable keys are supported. For filterable `string_values`, + # across all keys at most 200 values are allowed, with each string no more than + # 255 characters. For unfilterable `string_values`, the maximum total size of ` + # string_values` across all keys is 50KB. # Corresponds to the JSON property `customAttributes` # @return [Hash<String,Google::Apis::JobsV3::CustomAttribute>] attr_accessor :custom_attributes # Optional. The desired education degrees for the job, such as Bachelors, @@ -1141,212 +1071,187 @@ # Corresponds to the JSON property `degreeTypes` # @return [Array<String>] attr_accessor :degree_types # Optional. The department or functional area within the company with the open - # position. - # The maximum number of allowed characters is 255. + # position. The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. # Corresponds to the JSON property `derivedInfo` # @return [Google::Apis::JobsV3::JobDerivedInfo] attr_accessor :derived_info # Required. The description of the job, which typically includes a multi- - # paragraph - # description of the company and related information. Separate fields are - # provided on the job object for responsibilities, - # qualifications, and other job characteristics. Use of - # these separate job fields is recommended. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 100,000. + # paragraph description of the company and related information. Separate fields + # are provided on the job object for responsibilities, qualifications, and other + # job characteristics. Use of these separate job fields is recommended. This + # field accepts and sanitizes HTML input, and also accepts bold, italic, ordered + # list, and unordered list markup tags. The maximum number of allowed characters + # is 100,000. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. The employment type(s) of a job, for example, - # full time or - # part time. + # Optional. The employment type(s) of a job, for example, full time or part time. # Corresponds to the JSON property `employmentTypes` # @return [Array<String>] attr_accessor :employment_types # Optional. A description of bonus, commission, and other compensation - # incentives associated with the job not including salary or pay. - # The maximum number of allowed characters is 10,000. + # incentives associated with the job not including salary or pay. The maximum + # number of allowed characters is 10,000. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives # Optional. The benefits included with the job. # Corresponds to the JSON property `jobBenefits` # @return [Array<String>] attr_accessor :job_benefits # Optional. The end timestamp of the job. Typically this field is used for - # contracting - # engagements. Invalid timestamps are ignored. + # contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobEndTime` # @return [String] attr_accessor :job_end_time # Optional. The experience level associated with the job, such as "Entry Level". # Corresponds to the JSON property `jobLevel` # @return [String] attr_accessor :job_level # Optional. The start timestamp of the job in UTC time zone. Typically this - # field - # is used for contracting engagements. Invalid timestamps are ignored. + # field is used for contracting engagements. Invalid timestamps are ignored. # Corresponds to the JSON property `jobStartTime` # @return [String] attr_accessor :job_start_time - # Optional. The language of the posting. This field is distinct from - # any requirements for fluency that are associated with the job. - # Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: - # class="external" target="_blank" `. - # If this field is unspecified and Job.description is present, detected - # language code based on Job.description is assigned, otherwise - # defaults to 'en_US'. + # Optional. The language of the posting. This field is distinct from any + # requirements for fluency that are associated with the job. Language codes must + # be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [ + # Tags for Identifying Languages](https://tools.ietf.org/html/bcp47)`: class=" + # external" target="_blank" `. If this field is unspecified and Job.description + # is present, detected language code based on Job.description is assigned, + # otherwise defaults to 'en_US'. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Required during job update. - # The resource name for the job. This is generated by the service when a - # job is created. - # The format is "projects/`project_id`/jobs/`job_id`", - # for example, "projects/api-test-project/jobs/1234". - # Use of this field in job queries and API calls is preferred over the use of + # Required during job update. The resource name for the job. This is generated + # by the service when a job is created. The format is "projects/`project_id`/ + # jobs/`job_id`", for example, "projects/api-test-project/jobs/1234". Use of + # this field in job queries and API calls is preferred over the use of # requisition_id since this value is unique. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The timestamp when this job posting was created. # Corresponds to the JSON property `postingCreateTime` # @return [String] attr_accessor :posting_create_time - # Optional but strongly recommended for the best service - # experience. - # The expiration timestamp of the job. After this timestamp, the - # job is marked as expired, and it no longer appears in search results. The - # expired job can't be deleted or listed by the DeleteJob and - # ListJobs APIs, but it can be retrieved with the GetJob API or - # updated with the UpdateJob API. An expired job can be updated and - # opened again by using a future expiration timestamp. Updating an expired - # job fails if there is another existing open job with same company_name, - # language_code and requisition_id. - # The expired jobs are retained in our system for 90 days. However, the - # overall expired job count cannot exceed 3 times the maximum of open jobs - # count over the past week, otherwise jobs with earlier expire time are - # cleaned first. Expired jobs are no longer accessible after they are cleaned - # out. - # Invalid timestamps are ignored, and treated as expire time not provided. - # Timestamp before the instant request is made is considered valid, the job - # will be treated as expired immediately. - # If this value is not provided at the time of job creation or is invalid, - # the job posting expires after 30 days from the job's creation time. For - # example, if the job was created on 2017/01/01 13:00AM UTC with an - # unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. - # If this value is not provided on job update, it depends on the field masks - # set by UpdateJobRequest.update_mask. If the field masks include - # expiry_time, or the masks are empty meaning that every field is - # updated, the job posting expires after 30 days from the job's last + # Optional but strongly recommended for the best service experience. The + # expiration timestamp of the job. After this timestamp, the job is marked as + # expired, and it no longer appears in search results. The expired job can't be + # deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved + # with the GetJob API or updated with the UpdateJob API. An expired job can be + # updated and opened again by using a future expiration timestamp. Updating an + # expired job fails if there is another existing open job with same company_name, + # language_code and requisition_id. The expired jobs are retained in our system + # for 90 days. However, the overall expired job count cannot exceed 3 times the + # maximum of open jobs count over the past week, otherwise jobs with earlier + # expire time are cleaned first. Expired jobs are no longer accessible after + # they are cleaned out. Invalid timestamps are ignored, and treated as expire + # time not provided. Timestamp before the instant request is made is considered + # valid, the job will be treated as expired immediately. If this value is not + # provided at the time of job creation or is invalid, the job posting expires + # after 30 days from the job's creation time. For example, if the job was + # created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job + # expires after 2017/01/31 13:00AM UTC. If this value is not provided on job + # update, it depends on the field masks set by UpdateJobRequest.update_mask. If + # the field masks include expiry_time, or the masks are empty meaning that every + # field is updated, the job posting expires after 30 days from the job's last # update time. Otherwise the expiration date isn't updated. # Corresponds to the JSON property `postingExpireTime` # @return [String] attr_accessor :posting_expire_time # Optional. The timestamp this job posting was most recently published. The - # default - # value is the time the request arrives at the server. Invalid timestamps are - # ignored. + # default value is the time the request arrives at the server. Invalid + # timestamps are ignored. # Corresponds to the JSON property `postingPublishTime` # @return [String] attr_accessor :posting_publish_time # Optional. The job PostingRegion (for example, state, country) throughout which - # the job is available. If this field is set, a - # LocationFilter in a search query within the job region - # finds this job posting if an exact location match isn't specified. - # If this field is set to PostingRegion.NATION or - # PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses - # to the same location level as this field is strongly recommended. + # the job is available. If this field is set, a LocationFilter in a search query + # within the job region finds this job posting if an exact location match isn't + # specified. If this field is set to PostingRegion.NATION or PostingRegion. + # ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as + # this field is strongly recommended. # Corresponds to the JSON property `postingRegion` # @return [String] attr_accessor :posting_region # Output only. The timestamp when this job posting was last updated. # Corresponds to the JSON property `postingUpdateTime` # @return [String] attr_accessor :posting_update_time - # Input only. - # Options for job processing. + # Input only. Options for job processing. # Corresponds to the JSON property `processingOptions` # @return [Google::Apis::JobsV3::ProcessingOptions] attr_accessor :processing_options - # Optional. A promotion value of the job, as determined by the client. - # The value determines the sort order of the jobs returned when searching for - # jobs using the featured jobs search call, with higher promotional values - # being returned first and ties being resolved by relevance sort. Only the - # jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. - # Default value is 0, and negative values are treated as 0. + # Optional. A promotion value of the job, as determined by the client. The value + # determines the sort order of the jobs returned when searching for jobs using + # the featured jobs search call, with higher promotional values being returned + # first and ties being resolved by relevance sort. Only the jobs with a + # promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, + # and negative values are treated as 0. # Corresponds to the JSON property `promotionValue` # @return [Fixnum] attr_accessor :promotion_value - # Optional. A description of the qualifications required to perform the - # job. The use of this field is recommended - # as an alternative to using the more general description field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # Optional. A description of the qualifications required to perform the job. The + # use of this field is recommended as an alternative to using the more general + # description field. This field accepts and sanitizes HTML input, and also + # accepts bold, italic, ordered list, and unordered list markup tags. The + # maximum number of allowed characters is 10,000. # Corresponds to the JSON property `qualifications` # @return [String] attr_accessor :qualifications # Required. The requisition ID, also referred to as the posting ID, assigned by - # the - # client to identify a job. This field is intended to be used by clients - # for client identification and tracking of postings. A job is not allowed - # to be created if there is another job with the same [company_name], - # language_code and requisition_id. - # The maximum number of allowed characters is 255. + # the client to identify a job. This field is intended to be used by clients for + # client identification and tracking of postings. A job is not allowed to be + # created if there is another job with the same [company_name], language_code + # and requisition_id. The maximum number of allowed characters is 255. # Corresponds to the JSON property `requisitionId` # @return [String] attr_accessor :requisition_id # Optional. A description of job responsibilities. The use of this field is - # recommended as an alternative to using the more general description - # field. - # This field accepts and sanitizes HTML input, and also accepts - # bold, italic, ordered list, and unordered list markup tags. - # The maximum number of allowed characters is 10,000. + # recommended as an alternative to using the more general description field. + # This field accepts and sanitizes HTML input, and also accepts bold, italic, + # ordered list, and unordered list markup tags. The maximum number of allowed + # characters is 10,000. # Corresponds to the JSON property `responsibilities` # @return [String] attr_accessor :responsibilities - # Required. The title of the job, such as "Software Engineer" - # The maximum number of allowed characters is 500. + # Required. The title of the job, such as "Software Engineer" The maximum number + # of allowed characters is 500. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # Deprecated. The job is only visible to the owner. - # The visibility of the job. + # Deprecated. The job is only visible to the owner. The visibility of the job. # Defaults to Visibility.ACCOUNT_ONLY if not specified. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -1387,23 +1292,21 @@ @title = args[:title] if args.key?(:title) @visibility = args[:visibility] if args.key?(:visibility) end end - # Output only. - # Derived details about the job posting. + # Output only. Derived details about the job posting. class JobDerivedInfo include Google::Apis::Core::Hashable # Job categories derived from Job.title and Job.description. # Corresponds to the JSON property `jobCategories` # @return [Array<String>] attr_accessor :job_categories - # Structured locations of the job, resolved from Job.addresses. - # locations are exactly matched to Job.addresses in the same - # order. + # Structured locations of the job, resolved from Job.addresses. locations are + # exactly matched to Job.addresses in the same order. # Corresponds to the JSON property `locations` # @return [Array<Google::Apis::JobsV3::Location>] attr_accessor :locations def initialize(**args) @@ -1420,15 +1323,14 @@ # An event issued when a job seeker interacts with the application that # implements Cloud Talent Solution. class JobEvent include Google::Apis::Core::Hashable - # Required. The job name(s) associated with this event. - # For example, if this is an impression event, - # this field contains the identifiers of all jobs shown to the job seeker. - # If this was a view event, this field contains the - # identifier of the viewed job. + # Required. The job name(s) associated with this event. For example, if this is + # an impression event, this field contains the identifiers of all jobs shown to + # the job seeker. If this was a view event, this field contains the identifier + # of the viewed job. # Corresponds to the JSON property `jobs` # @return [Array<String>] attr_accessor :jobs # Required. The type of the event (see JobEventType). @@ -1445,145 +1347,121 @@ @jobs = args[:jobs] if args.key?(:jobs) @type = args[:type] if args.key?(:type) end end - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. class JobQuery include Google::Apis::Core::Hashable - # Input only. - # Parameters needed for commute search. + # Input only. Parameters needed for commute search. # Corresponds to the JSON property `commuteFilter` # @return [Google::Apis::JobsV3::CommuteFilter] attr_accessor :commute_filter - # Optional. This filter specifies the exact company display - # name of the jobs to search against. - # If a value isn't specified, jobs within the search results are - # associated with any company. - # If multiple values are specified, jobs within the search results may be - # associated with any of the specified companies. - # At most 20 company display name filters are allowed. + # Optional. This filter specifies the exact company display name of the jobs to + # search against. If a value isn't specified, jobs within the search results are + # associated with any company. If multiple values are specified, jobs within the + # search results may be associated with any of the specified companies. At most + # 20 company display name filters are allowed. # Corresponds to the JSON property `companyDisplayNames` # @return [Array<String>] attr_accessor :company_display_names - # Optional. This filter specifies the company entities to search against. - # If a value isn't specified, jobs are searched for against all - # companies. - # If multiple values are specified, jobs are searched against the - # companies specified. - # The format is "projects/`project_id`/companies/`company_id`", for example, - # "projects/api-test-project/companies/foo". - # At most 20 company filters are allowed. + # Optional. This filter specifies the company entities to search against. If a + # value isn't specified, jobs are searched for against all companies. If + # multiple values are specified, jobs are searched against the companies + # specified. The format is "projects/`project_id`/companies/`company_id`", for + # example, "projects/api-test-project/companies/foo". At most 20 company filters + # are allowed. # Corresponds to the JSON property `companyNames` # @return [Array<String>] attr_accessor :company_names - # Input only. - # Filter on job compensation type and amount. + # Input only. Filter on job compensation type and amount. # Corresponds to the JSON property `compensationFilter` # @return [Google::Apis::JobsV3::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the - # Job.custom_attributes marked as `filterable`. - # The syntax for this expression is a subset of SQL syntax. - # Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the - # left of the operator is a custom field key and the right of the operator - # is a number or a quoted string. You must escape backslash (\\) and - # quote (\") characters. - # Supported functions are `LOWER([field_name])` to + # Optional. This filter specifies a structured syntax to match against the Job. + # custom_attributes marked as `filterable`. The syntax for this expression is a + # subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and ` + # >=` where the left of the operator is a custom field key and the right of the + # operator is a number or a quoted string. You must escape backslash (\\) and + # quote (\") characters. Supported functions are `LOWER([field_name])` to # perform a case insensitive match and `EMPTY([field_name])` to filter on the - # existence of a key. - # Boolean expressions (AND/OR/NOT) are supported up to 3 levels of - # nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 - # comparisons or functions are allowed in the expression. The expression - # must be < 6000 bytes in length. - # Sample Query: - # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND - # driving_years > 10` + # existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 + # levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum + # of 100 comparisons or functions are allowed in the expression. The expression + # must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \ + # "a\"" OR EMPTY(driving_license)) AND driving_years > 10` # Corresponds to the JSON property `customAttributeFilter` # @return [String] attr_accessor :custom_attribute_filter - # Optional. This flag controls the spell-check feature. If false, the - # service attempts to correct a misspelled query, - # for example, "enginee" is corrected to "engineer". - # Defaults to false: a spell check is performed. + # Optional. This flag controls the spell-check feature. If false, the service + # attempts to correct a misspelled query, for example, "enginee" is corrected to + # "engineer". Defaults to false: a spell check is performed. # Corresponds to the JSON property `disableSpellCheck` # @return [Boolean] attr_accessor :disable_spell_check alias_method :disable_spell_check?, :disable_spell_check # Optional. The employment type filter specifies the employment type of jobs to - # search against, such as EmploymentType.FULL_TIME. - # If a value is not specified, jobs in the search results includes any - # employment type. - # If multiple values are specified, jobs in the search results include - # any of the specified employment types. + # search against, such as EmploymentType.FULL_TIME. If a value is not specified, + # jobs in the search results includes any employment type. If multiple values + # are specified, jobs in the search results include any of the specified + # employment types. # Corresponds to the JSON property `employmentTypes` # @return [Array<String>] attr_accessor :employment_types # Optional. The category filter specifies the categories of jobs to search - # against. - # See Category for more information. - # If a value is not specified, jobs from any category are searched against. - # If multiple values are specified, jobs from any of the specified - # categories are searched against. + # against. See Category for more information. If a value is not specified, jobs + # from any category are searched against. If multiple values are specified, jobs + # from any of the specified categories are searched against. # Corresponds to the JSON property `jobCategories` # @return [Array<String>] attr_accessor :job_categories - # Optional. This filter specifies the locale of jobs to search against, - # for example, "en-US". - # If a value isn't specified, the search results can contain jobs in any - # locale. - # Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). - # At most 10 language code filters are allowed. + # Optional. This filter specifies the locale of jobs to search against, for + # example, "en-US". If a value isn't specified, the search results can contain + # jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" + # or "sr-Latn". For more information, see [Tags for Identifying Languages](https: + # //tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. # Corresponds to the JSON property `languageCodes` # @return [Array<String>] attr_accessor :language_codes # Optional. The location filter specifies geo-regions containing the jobs to - # search against. See LocationFilter for more information. - # If a location value isn't specified, jobs fitting the other search - # criteria are retrieved regardless of where they're located. - # If multiple values are specified, jobs are retrieved from any of the - # specified locations. If different values are specified for the - # LocationFilter.distance_in_miles parameter, the maximum provided - # distance is used for all locations. - # At most 5 location filters are allowed. + # search against. See LocationFilter for more information. If a location value + # isn't specified, jobs fitting the other search criteria are retrieved + # regardless of where they're located. If multiple values are specified, jobs + # are retrieved from any of the specified locations. If different values are + # specified for the LocationFilter.distance_in_miles parameter, the maximum + # provided distance is used for all locations. At most 5 location filters are + # allowed. # Corresponds to the JSON property `locationFilters` # @return [Array<Google::Apis::JobsV3::LocationFilter>] attr_accessor :location_filters # Message representing a period of time between two timestamps. # Corresponds to the JSON property `publishTimeRange` # @return [Google::Apis::JobsV3::TimestampRange] attr_accessor :publish_time_range # Optional. The query string that matches against the job title, description, - # and - # location fields. - # The maximum number of allowed characters is 255. + # and location fields. The maximum number of allowed characters is 255. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query - # The language code of query. For example, "en-US". This field helps to - # better interpret the query. - # If a value isn't specified, the query language code is automatically - # detected, which may not be accurate. - # Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". - # For more information, see - # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). + # The language code of query. For example, "en-US". This field helps to better + # interpret the query. If a value isn't specified, the query language code is + # automatically detected, which may not be accurate. Language code should be in + # BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags + # for Identifying Languages](https://tools.ietf.org/html/bcp47). # Corresponds to the JSON property `queryLanguageCode` # @return [String] attr_accessor :query_language_code def initialize(**args) @@ -1608,13 +1486,12 @@ end end # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - # standard</a>. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable # The latitude in degrees. It must be in the range [-90.0, +90.0]. # Corresponds to the JSON property `latitude` @@ -1635,22 +1512,21 @@ @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end - # Output only. - # The List companies response object. + # Output only. The List companies response object. class ListCompaniesResponse include Google::Apis::Core::Hashable # Companies for the current client. # Corresponds to the JSON property `companies` # @return [Array<Google::Apis::JobsV3::Company>] attr_accessor :companies - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata # A token to retrieve the next page of results. @@ -1668,24 +1544,22 @@ @metadata = args[:metadata] if args.key?(:metadata) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end - # Output only. - # List jobs response. + # Output only. List jobs response. class ListJobsResponse include Google::Apis::Core::Hashable - # The Jobs for a given company. - # The maximum number of items returned is based on the limit field - # provided in the request. + # The Jobs for a given company. The maximum number of items returned is based on + # the limit field provided in the request. # Corresponds to the JSON property `jobs` # @return [Array<Google::Apis::JobsV3::Job>] attr_accessor :jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata # A token to retrieve the next page of results. @@ -1703,20 +1577,19 @@ @metadata = args[:metadata] if args.key?(:metadata) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end - # Output only. - # A resource that represents a location with full geographic information. + # Output only. A resource that represents a location with full geographic + # information. class Location include Google::Apis::Core::Hashable # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - # standard</a>. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :lat_lng # The type of a location, which corresponds to the address lines field of @@ -1727,31 +1600,26 @@ # @return [String] attr_accessor :location_type # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 # Corresponds to the JSON property `postalAddress` # @return [Google::Apis::JobsV3::PostalAddress] attr_accessor :postal_address - # Radius in miles of the job location. This value is derived from the - # location bounding box in which a circle with the specified radius - # centered from LatLng covers the area associated with the job location. - # For example, currently, "Mountain View, CA, USA" has a radius of - # 6.17 miles. + # Radius in miles of the job location. This value is derived from the location + # bounding box in which a circle with the specified radius centered from LatLng + # covers the area associated with the job location. For example, currently, " + # Mountain View, CA, USA" has a radius of 6.17 miles. # Corresponds to the JSON property `radiusInMiles` # @return [Float] attr_accessor :radius_in_miles def initialize(**args) @@ -1765,64 +1633,57 @@ @postal_address = args[:postal_address] if args.key?(:postal_address) @radius_in_miles = args[:radius_in_miles] if args.key?(:radius_in_miles) end end - # Input only. - # Geographic region of the search. + # Input only. Geographic region of the search. class LocationFilter include Google::Apis::Core::Hashable # Optional. The address name, such as "Mountain View" or "Bay Area". # Corresponds to the JSON property `address` # @return [String] attr_accessor :address # Optional. The distance_in_miles is applied when the location being searched - # for is - # identified as a city or smaller. When the location being searched for is a - # state or larger, this field is ignored. + # for is identified as a city or smaller. When the location being searched for + # is a state or larger, this field is ignored. # Corresponds to the JSON property `distanceInMiles` # @return [Float] attr_accessor :distance_in_miles # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - # standard</a>. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::JobsV3::LatLng] attr_accessor :lat_lng # Optional. CLDR region code of the country/region of the address. This is used # to address ambiguity of the user-input location, for example, "Liverpool" - # against "Liverpool, NY, US" or "Liverpool, UK". - # Set this field if all the jobs to search against are from a same region, - # or jobs are world-wide, but the job seeker is from a specific region. - # See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs + # to search against are from a same region, or jobs are world-wide, but the job + # seeker is from a specific region. See http://cldr.unicode.org/ and http://www. + # unicode.org/cldr/charts/30/supplemental/territory_information.html for details. + # Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code - # Optional. Allows the client to return jobs without a - # set location, specifically, telecommuting jobs (telecommuting is considered - # by the service as a special location. - # Job.posting_region indicates if a job permits telecommuting. - # If this field is set to TelecommutePreference.TELECOMMUTE_ALLOWED, - # telecommuting jobs are searched, and address and lat_lng are - # ignored. If not set or set to - # TelecommutePreference.TELECOMMUTE_EXCLUDED, telecommute job are not - # searched. - # This filter can be used by itself to search exclusively for telecommuting - # jobs, or it can be combined with another location - # filter to search for a combination of job locations, - # such as "Mountain View" or "telecommuting" jobs. However, when used in - # combination with other location filters, telecommuting jobs can be - # treated as less relevant than other jobs in the search response. + # Optional. Allows the client to return jobs without a set location, + # specifically, telecommuting jobs (telecommuting is considered by the service + # as a special location. Job.posting_region indicates if a job permits + # telecommuting. If this field is set to TelecommutePreference. + # TELECOMMUTE_ALLOWED, telecommuting jobs are searched, and address and lat_lng + # are ignored. If not set or set to TelecommutePreference.TELECOMMUTE_EXCLUDED, + # telecommute job are not searched. This filter can be used by itself to search + # exclusively for telecommuting jobs, or it can be combined with another + # location filter to search for a combination of job locations, such as " + # Mountain View" or "telecommuting" jobs. However, when used in combination with + # other location filters, telecommuting jobs can be treated as less relevant + # than other jobs in the search response. # Corresponds to the JSON property `telecommutePreference` # @return [String] attr_accessor :telecommute_preference def initialize(**args) @@ -1837,45 +1698,43 @@ @region_code = args[:region_code] if args.key?(:region_code) @telecommute_preference = args[:telecommute_preference] if args.key?(:telecommute_preference) end end - # Output only. - # Job entry with metadata inside SearchJobsResponse. + # Output only. Job entry with metadata inside SearchJobsResponse. class MatchingJob include Google::Apis::Core::Hashable - # Output only. - # Commute details related to this job. + # Output only. Commute details related to this job. # Corresponds to the JSON property `commuteInfo` # @return [Google::Apis::JobsV3::CommuteInfo] attr_accessor :commute_info # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job # A summary of the job with core information that's displayed on the search # results listing page. # Corresponds to the JSON property `jobSummary` # @return [String] attr_accessor :job_summary - # Contains snippets of text from the Job.job_title field most - # closely matching a search query's keywords, if available. The matching - # query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.job_title field most closely matching a + # search query's keywords, if available. The matching query keywords are + # enclosed in HTML bold tags. # Corresponds to the JSON property `jobTitleSnippet` # @return [String] attr_accessor :job_title_snippet - # Contains snippets of text from the Job.description and similar - # fields that most closely match a search query's keywords, if available. - # All HTML tags in the original fields are stripped when returned in this - # field, and matching query keywords are enclosed in HTML bold tags. + # Contains snippets of text from the Job.description and similar fields that + # most closely match a search query's keywords, if available. All HTML tags in + # the original fields are stripped when returned in this field, and matching + # query keywords are enclosed in HTML bold tags. # Corresponds to the JSON property `searchTextSnippet` # @return [String] attr_accessor :search_text_snippet def initialize(**args) @@ -1890,24 +1749,22 @@ @job_title_snippet = args[:job_title_snippet] if args.key?(:job_title_snippet) @search_text_snippet = args[:search_text_snippet] if args.key?(:search_text_snippet) end end - # Message representing input to a Mendel server for debug forcing. - # See go/mendel-debug-forcing for more details. - # Next ID: 2 + # Message representing input to a Mendel server for debug forcing. See go/mendel- + # debug-forcing for more details. Next ID: 2 class MendelDebugInput include Google::Apis::Core::Hashable - # When a request spans multiple servers, a MendelDebugInput may travel with - # the request and take effect in all the servers. This field is a map of - # namespaces to NamespacedMendelDebugInput protos. In a single server, up to - # two NamespacedMendelDebugInput protos are applied: - # 1. NamespacedMendelDebugInput with the global namespace (key == ""). - # 2. NamespacedMendelDebugInput with the server's namespace. - # When both NamespacedMendelDebugInput protos are present, they are merged. - # See go/mendel-debug-forcing for more details. + # When a request spans multiple servers, a MendelDebugInput may travel with the + # request and take effect in all the servers. This field is a map of namespaces + # to NamespacedMendelDebugInput protos. In a single server, up to two + # NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput + # with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the + # server's namespace. When both NamespacedMendelDebugInput protos are present, + # they are merged. See go/mendel-debug-forcing for more details. # Corresponds to the JSON property `namespacedDebugInput` # @return [Hash<String,Google::Apis::JobsV3::NamespacedDebugInput>] attr_accessor :namespaced_debug_input def initialize(**args) @@ -1927,22 +1784,21 @@ # The 3-letter currency code defined in ISO 4217. # Corresponds to the JSON property `currencyCode` # @return [String] attr_accessor :currency_code - # Number of nano (10^-9) units of the amount. - # The value must be between -999,999,999 and +999,999,999 inclusive. - # If `units` is positive, `nanos` must be positive or zero. - # If `units` is zero, `nanos` can be positive, zero, or negative. - # If `units` is negative, `nanos` must be negative or zero. - # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + # Number of nano (10^-9) units of the amount. The value must be between -999,999, + # 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be + # positive or zero. If `units` is zero, `nanos` can be positive, zero, or + # negative. If `units` is negative, `nanos` must be negative or zero. For + # example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. # Corresponds to the JSON property `nanos` # @return [Fixnum] attr_accessor :nanos - # The whole units of the amount. - # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + # The whole units of the amount. For example if `currencyCode` is `"USD"`, then + # 1 unit is one US dollar. # Corresponds to the JSON property `units` # @return [Fixnum] attr_accessor :units def initialize(**args) @@ -1959,118 +1815,113 @@ # Next ID: 15 class NamespacedDebugInput include Google::Apis::Core::Hashable - # Set of experiment names to be absolutely forced. - # These experiments will be forced without evaluating the conditions. + # Set of experiment names to be absolutely forced. These experiments will be + # forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpNames` # @return [Array<String>] attr_accessor :absolutely_forced_exp_names - # Set of experiment tags to be absolutely forced. - # The experiments with these tags will be forced without evaluating the - # conditions. + # Set of experiment tags to be absolutely forced. The experiments with these + # tags will be forced without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExpTags` # @return [Array<String>] attr_accessor :absolutely_forced_exp_tags - # Set of experiment ids to be absolutely forced. - # These ids will be forced without evaluating the conditions. + # Set of experiment ids to be absolutely forced. These ids will be forced + # without evaluating the conditions. # Corresponds to the JSON property `absolutelyForcedExps` # @return [Array<Fixnum>] attr_accessor :absolutely_forced_exps - # Set of experiment names to be conditionally forced. - # These experiments will be forced only if their conditions and their - # parent domain's conditions are true. + # Set of experiment names to be conditionally forced. These experiments will be + # forced only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExpNames` # @return [Array<String>] attr_accessor :conditionally_forced_exp_names - # Set of experiment tags to be conditionally forced. - # The experiments with these tags will be forced only if their conditions - # and their parent domain's conditions are true. + # Set of experiment tags to be conditionally forced. The experiments with these + # tags will be forced only if their conditions and their parent domain's + # conditions are true. # Corresponds to the JSON property `conditionallyForcedExpTags` # @return [Array<String>] attr_accessor :conditionally_forced_exp_tags - # Set of experiment ids to be conditionally forced. - # These ids will be forced only if their conditions and their parent - # domain's conditions are true. + # Set of experiment ids to be conditionally forced. These ids will be forced + # only if their conditions and their parent domain's conditions are true. # Corresponds to the JSON property `conditionallyForcedExps` # @return [Array<Fixnum>] attr_accessor :conditionally_forced_exps - # If true, disable automatic enrollment selection (at all diversion - # points). Automatic enrollment selection means experiment selection - # process based on the experiment's automatic enrollment condition. This - # does not disable selection of forced experiments. + # If true, disable automatic enrollment selection (at all diversion points). + # Automatic enrollment selection means experiment selection process based on the + # experiment's automatic enrollment condition. This does not disable selection + # of forced experiments. # Corresponds to the JSON property `disableAutomaticEnrollmentSelection` # @return [Boolean] attr_accessor :disable_automatic_enrollment_selection alias_method :disable_automatic_enrollment_selection?, :disable_automatic_enrollment_selection - # Set of experiment names to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If a name corresponds to a domain, the domain - # itself and all descendant experiments and domains are disabled together. + # Set of experiment names to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If a name corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExpNames` # @return [Array<String>] attr_accessor :disable_exp_names - # Set of experiment tags to be disabled. All experiments that are tagged - # with one or more of these tags are disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. + # Set of experiment tags to be disabled. All experiments that are tagged with + # one or more of these tags are disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. # Corresponds to the JSON property `disableExpTags` # @return [Array<String>] attr_accessor :disable_exp_tags - # Set of experiment ids to be disabled. - # If an experiment is disabled, it is never selected nor forced. - # If an aggregate experiment is disabled, its partitions are disabled - # together. If an experiment with an enrollment is disabled, the enrollment - # is disabled together. If an ID corresponds to a domain, the domain itself - # and all descendant experiments and domains are disabled together. + # Set of experiment ids to be disabled. If an experiment is disabled, it is + # never selected nor forced. If an aggregate experiment is disabled, its + # partitions are disabled together. If an experiment with an enrollment is + # disabled, the enrollment is disabled together. If an ID corresponds to a + # domain, the domain itself and all descendant experiments and domains are + # disabled together. # Corresponds to the JSON property `disableExps` # @return [Array<Fixnum>] attr_accessor :disable_exps - # If true, disable manual enrollment selection (at all diversion points). - # Manual enrollment selection means experiment selection process based on - # the request's manual enrollment states (a.k.a. opt-in experiments). - # This does not disable selection of forced experiments. + # If true, disable manual enrollment selection (at all diversion points). Manual + # enrollment selection means experiment selection process based on the request's + # manual enrollment states (a.k.a. opt-in experiments). This does not disable + # selection of forced experiments. # Corresponds to the JSON property `disableManualEnrollmentSelection` # @return [Boolean] attr_accessor :disable_manual_enrollment_selection alias_method :disable_manual_enrollment_selection?, :disable_manual_enrollment_selection # If true, disable organic experiment selection (at all diversion points). # Organic selection means experiment selection process based on traffic - # allocation and diversion condition evaluation. - # This does not disable selection of forced experiments. - # This is useful in cases when it is not known whether experiment selection - # behavior is responsible for a error or breakage. Disabling organic - # selection may help to isolate the cause of a given problem. + # allocation and diversion condition evaluation. This does not disable selection + # of forced experiments. This is useful in cases when it is not known whether + # experiment selection behavior is responsible for a error or breakage. + # Disabling organic selection may help to isolate the cause of a given problem. # Corresponds to the JSON property `disableOrganicSelection` # @return [Boolean] attr_accessor :disable_organic_selection alias_method :disable_organic_selection?, :disable_organic_selection - # Flags to force in a particular experiment state. - # Map from flag name to flag value. + # Flags to force in a particular experiment state. Map from flag name to flag + # value. # Corresponds to the JSON property `forcedFlags` # @return [Hash<String,String>] attr_accessor :forced_flags - # Rollouts to force in a particular experiment state. - # Map from rollout name to rollout value. + # Rollouts to force in a particular experiment state. Map from rollout name to + # rollout value. # Corresponds to the JSON property `forcedRollouts` # @return [Hash<String,Boolean>] attr_accessor :forced_rollouts def initialize(**args) @@ -2094,25 +1945,25 @@ @forced_flags = args[:forced_flags] if args.key?(:forced_flags) @forced_rollouts = args[:forced_rollouts] if args.key?(:forced_rollouts) end end - # Input only. - # Use this field to specify bucketing option for the histogram search response. + # Input only. Use this field to specify bucketing option for the histogram + # search response. class NumericBucketingOption include Google::Apis::Core::Hashable # Required. Two adjacent values form a histogram bucket. Values should be in # ascending order. For example, if [5, 10, 15] are provided, four buckets are - # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 - # [buckets_bound is supported. + # created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is + # supported. # Corresponds to the JSON property `bucketBounds` # @return [Array<Float>] attr_accessor :bucket_bounds - # Optional. If set to true, the histogram result includes minimum/maximum - # value of the numeric field. + # Optional. If set to true, the histogram result includes minimum/maximum value + # of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] attr_accessor :requires_min_max alias_method :requires_min_max?, :requires_min_max @@ -2125,29 +1976,28 @@ @bucket_bounds = args[:bucket_bounds] if args.key?(:bucket_bounds) @requires_min_max = args[:requires_min_max] if args.key?(:requires_min_max) end end - # Output only. - # Custom numeric bucketing result. + # Output only. Custom numeric bucketing result. class NumericBucketingResult include Google::Apis::Core::Hashable - # Count within each bucket. Its size is the length of - # NumericBucketingOption.bucket_bounds plus 1. + # Count within each bucket. Its size is the length of NumericBucketingOption. + # bucket_bounds plus 1. # Corresponds to the JSON property `counts` # @return [Array<Google::Apis::JobsV3::BucketizedCount>] attr_accessor :counts - # Stores the maximum value of the numeric field. Is populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the maximum value of the numeric field. Is populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # Stores the minimum value of the numeric field. Will be populated only if - # [NumericBucketingOption.requires_min_max] is set to true. + # Stores the minimum value of the numeric field. Will be populated only if [ + # NumericBucketingOption.requires_min_max] is set to true. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value def initialize(**args) @@ -2162,128 +2012,117 @@ end end # Represents a postal address, e.g. for postal delivery or payments addresses. # Given a postal address, a postal service can deliver items to a premise, P.O. - # Box or similar. - # It is not intended to model geographical locations (roads, towns, - # mountains). - # In typical usage an address would be created via user input or from importing - # existing data, depending on the type of process. - # Advice on address input / editing: - # - Use an i18n-ready address widget such as - # https://github.com/google/libaddressinput) - # - Users should not be presented with UI elements for input or editing of - # fields outside countries where that field is used. - # For more guidance on how to use this schema, please see: - # https://support.google.com/business/answer/6397478 + # Box or similar. It is not intended to model geographical locations (roads, + # towns, mountains). In typical usage an address would be created via user input + # or from importing existing data, depending on the type of process. Advice on + # address input / editing: - Use an i18n-ready address widget such as https:// + # github.com/google/libaddressinput) - Users should not be presented with UI + # elements for input or editing of fields outside countries where that field is + # used. For more guidance on how to use this schema, please see: https://support. + # google.com/business/answer/6397478 class PostalAddress include Google::Apis::Core::Hashable - # Unstructured address lines describing the lower levels of an address. - # Because values in address_lines do not have type information and may - # sometimes contain multiple values in a single field (e.g. - # "Austin, TX"), it is important that the line order is clear. The order of - # address lines should be "envelope order" for the country/region of the - # address. In places where this can vary (e.g. Japan), address_language is - # used to make it explicit (e.g. "ja" for large-to-small ordering and - # "ja-Latn" or "en" for small-to-large). This way, the most specific line of - # an address can be selected based on the language. - # The minimum permitted structural representation of an address consists - # of a region_code with all remaining information placed in the - # address_lines. It would be possible to format such an address very - # approximately without geocoding, but no semantic reasoning could be - # made about any of the address components until it was at least - # partially resolved. - # Creating an address only containing a region_code and address_lines, and - # then geocoding is the recommended way to handle completely unstructured - # addresses (as opposed to guessing which parts of the address should be - # localities or administrative areas). + # Unstructured address lines describing the lower levels of an address. Because + # values in address_lines do not have type information and may sometimes contain + # multiple values in a single field (e.g. "Austin, TX"), it is important that + # the line order is clear. The order of address lines should be "envelope order" + # for the country/region of the address. In places where this can vary (e.g. + # Japan), address_language is used to make it explicit (e.g. "ja" for large-to- + # small ordering and "ja-Latn" or "en" for small-to-large). This way, the most + # specific line of an address can be selected based on the language. The minimum + # permitted structural representation of an address consists of a region_code + # with all remaining information placed in the address_lines. It would be + # possible to format such an address very approximately without geocoding, but + # no semantic reasoning could be made about any of the address components until + # it was at least partially resolved. Creating an address only containing a + # region_code and address_lines, and then geocoding is the recommended way to + # handle completely unstructured addresses (as opposed to guessing which parts + # of the address should be localities or administrative areas). # Corresponds to the JSON property `addressLines` # @return [Array<String>] attr_accessor :address_lines # Optional. Highest administrative subdivision which is used for postal - # addresses of a country or region. - # For example, this can be a state, a province, an oblast, or a prefecture. - # Specifically, for Spain this is the province and not the autonomous - # community (e.g. "Barcelona" and not "Catalonia"). - # Many countries don't use an administrative area in postal addresses. E.g. - # in Switzerland this should be left unpopulated. + # addresses of a country or region. For example, this can be a state, a province, + # an oblast, or a prefecture. Specifically, for Spain this is the province and + # not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many + # countries don't use an administrative area in postal addresses. E.g. in + # Switzerland this should be left unpopulated. # Corresponds to the JSON property `administrativeArea` # @return [String] attr_accessor :administrative_area - # Optional. BCP-47 language code of the contents of this address (if - # known). This is often the UI language of the input form or is expected - # to match one of the languages used in the address' country/region, or their - # transliterated equivalents. - # This can affect formatting in certain countries, but is not critical - # to the correctness of the data and will never affect any validation or - # other non-formatting related operations. - # If this value is not known, it should be omitted (rather than specifying a - # possibly incorrect default). + # Optional. BCP-47 language code of the contents of this address (if known). + # This is often the UI language of the input form or is expected to match one of + # the languages used in the address' country/region, or their transliterated + # equivalents. This can affect formatting in certain countries, but is not + # critical to the correctness of the data and will never affect any validation + # or other non-formatting related operations. If this value is not known, it + # should be omitted (rather than specifying a possibly incorrect default). # Examples: "zh-Hant", "ja", "ja-Latn", "en". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Optional. Generally refers to the city/town portion of the address. - # Examples: US city, IT comune, UK post town. - # In regions of the world where localities are not well defined or do not fit - # into this structure well, leave locality empty and use address_lines. + # Optional. Generally refers to the city/town portion of the address. Examples: + # US city, IT comune, UK post town. In regions of the world where localities are + # not well defined or do not fit into this structure well, leave locality empty + # and use address_lines. # Corresponds to the JSON property `locality` # @return [String] attr_accessor :locality # Optional. The name of the organization at the address. # Corresponds to the JSON property `organization` # @return [String] attr_accessor :organization - # Optional. Postal code of the address. Not all countries use or require - # postal codes to be present, but where they are used, they may trigger - # additional validation with other parts of the address (e.g. state/zip - # validation in the U.S.A.). + # Optional. Postal code of the address. Not all countries use or require postal + # codes to be present, but where they are used, they may trigger additional + # validation with other parts of the address (e.g. state/zip validation in the U. + # S.A.). # Corresponds to the JSON property `postalCode` # @return [String] attr_accessor :postal_code - # Optional. The recipient at the address. - # This field may, under certain circumstances, contain multiline information. - # For example, it might contain "care of" information. + # Optional. The recipient at the address. This field may, under certain + # circumstances, contain multiline information. For example, it might contain " + # care of" information. # Corresponds to the JSON property `recipients` # @return [Array<String>] attr_accessor :recipients - # Required. CLDR region code of the country/region of the address. This - # is never inferred and it is up to the user to ensure the value is - # correct. See http://cldr.unicode.org/ and - # http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html - # for details. Example: "CH" for Switzerland. + # Required. CLDR region code of the country/region of the address. This is never + # inferred and it is up to the user to ensure the value is correct. See http:// + # cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/ + # territory_information.html for details. Example: "CH" for Switzerland. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code # The schema revision of the `PostalAddress`. This must be set to 0, which is - # the latest revision. - # All new revisions **must** be backward compatible with old revisions. + # the latest revision. All new revisions **must** be backward compatible with + # old revisions. # Corresponds to the JSON property `revision` # @return [Fixnum] attr_accessor :revision - # Optional. Additional, country-specific, sorting code. This is not used - # in most regions. Where it is used, the value is either a string like - # "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number - # alone, representing the "sector code" (Jamaica), "delivery area indicator" - # (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). + # Optional. Additional, country-specific, sorting code. This is not used in most + # regions. Where it is used, the value is either a string like "CEDEX", + # optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, + # representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) + # or "post office indicator" (e.g. Côte d'Ivoire). # Corresponds to the JSON property `sortingCode` # @return [String] attr_accessor :sorting_code - # Optional. Sublocality of the address. - # For example, this can be neighborhoods, boroughs, districts. + # Optional. Sublocality of the address. For example, this can be neighborhoods, + # boroughs, districts. # Corresponds to the JSON property `sublocality` # @return [String] attr_accessor :sublocality def initialize(**args) @@ -2304,31 +2143,25 @@ @sorting_code = args[:sorting_code] if args.key?(:sorting_code) @sublocality = args[:sublocality] if args.key?(:sublocality) end end - # Input only. - # Options for job processing. + # Input only. Options for job processing. class ProcessingOptions include Google::Apis::Core::Hashable - # Optional. If set to `true`, the service does not attempt to resolve a - # more precise address for the job. + # Optional. If set to `true`, the service does not attempt to resolve a more + # precise address for the job. # Corresponds to the JSON property `disableStreetAddressResolution` # @return [Boolean] attr_accessor :disable_street_address_resolution alias_method :disable_street_address_resolution?, :disable_street_address_resolution - # Optional. Option for job HTML content sanitization. Applied fields are: - # * description - # * applicationInfo.instruction - # * incentives - # * qualifications - # * responsibilities - # HTML tags in these fields may be stripped if sanitiazation is not - # disabled. - # Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + # Optional. Option for job HTML content sanitization. Applied fields are: * + # description * applicationInfo.instruction * incentives * qualifications * + # responsibilities HTML tags in these fields may be stripped if sanitiazation is + # not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. # Corresponds to the JSON property `htmlSanitization` # @return [String] attr_accessor :html_sanitization def initialize(**args) @@ -2340,62 +2173,54 @@ @disable_street_address_resolution = args[:disable_street_address_resolution] if args.key?(:disable_street_address_resolution) @html_sanitization = args[:html_sanitization] if args.key?(:html_sanitization) end end - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. class RequestMetadata include Google::Apis::Core::Hashable - # Device information collected from the job seeker, candidate, or - # other entity conducting the job search. Providing this information improves - # the quality of the search results across devices. + # Device information collected from the job seeker, candidate, or other entity + # conducting the job search. Providing this information improves the quality of + # the search results across devices. # Corresponds to the JSON property `deviceInfo` # @return [Google::Apis::JobsV3::DeviceInfo] attr_accessor :device_info # Required. The client-defined scope or source of the service call, which - # typically - # is the domain on - # which the service has been implemented and is currently being run. - # For example, if the service is being run by client <em>Foo, Inc.</em>, on - # job board www.foo.com and career site www.bar.com, then this field is - # set to "foo.com" for use on the job board, and "bar.com" for use on the - # career site. - # If this field isn't available for some reason, send "UNKNOWN". - # Any improvements to the model for a particular tenant site rely on this - # field being set correctly to a domain. - # The maximum number of allowed characters is 255. + # typically is the domain on which the service has been implemented and is + # currently being run. For example, if the service is being run by client *Foo, + # Inc.*, on job board www.foo.com and career site www.bar.com, then this field + # is set to "foo.com" for use on the job board, and "bar.com" for use on the + # career site. If this field isn't available for some reason, send "UNKNOWN". + # Any improvements to the model for a particular tenant site rely on this field + # being set correctly to a domain. The maximum number of allowed characters is + # 255. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain # Required. A unique session identification string. A session is defined as the - # duration of an end user's interaction with the service over a certain - # period. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to some unique session_id. - # The maximum number of allowed characters is 255. + # duration of an end user's interaction with the service over a certain period. + # Obfuscate this field for privacy concerns before providing it to the service. + # If this field is not available for some reason, send "UNKNOWN". Note that any + # improvements to the model for a particular tenant site, rely on this field + # being set correctly to some unique session_id. The maximum number of allowed + # characters is 255. # Corresponds to the JSON property `sessionId` # @return [String] attr_accessor :session_id - # Required. A unique user identification string, as determined by the client. - # To have the strongest positive impact on search quality - # make sure the client-level is unique. - # Obfuscate this field for privacy concerns before - # providing it to the service. - # If this field is not available for some reason, send "UNKNOWN". Note - # that any improvements to the model for a particular tenant - # site, rely on this field being set correctly to a unique user_id. - # The maximum number of allowed characters is 255. + # Required. A unique user identification string, as determined by the client. To + # have the strongest positive impact on search quality make sure the client- + # level is unique. Obfuscate this field for privacy concerns before providing it + # to the service. If this field is not available for some reason, send "UNKNOWN". + # Note that any improvements to the model for a particular tenant site, rely on + # this field being set correctly to a unique user_id. The maximum number of + # allowed characters is 255. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id def initialize(**args) @@ -2409,17 +2234,16 @@ @session_id = args[:session_id] if args.key?(:session_id) @user_id = args[:user_id] if args.key?(:user_id) end end - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. class ResponseMetadata include Google::Apis::Core::Hashable - # A unique id associated with this call. - # This id is logged for tracking purposes. + # A unique id associated with this call. This id is logged for tracking purposes. # Corresponds to the JSON property `requestId` # @return [String] attr_accessor :request_id def initialize(**args) @@ -2430,118 +2254,95 @@ def update!(**args) @request_id = args[:request_id] if args.key?(:request_id) end end - # Input only. - # The Request body of the `SearchJobs` call. + # Input only. The Request body of the `SearchJobs` call. class SearchJobsRequest include Google::Apis::Core::Hashable # Optional. Controls whether to disable exact keyword match on Job.job_title, - # Job.description, Job.company_display_name, Job.locations, - # Job.qualifications. When disable keyword match is turned off, a - # keyword match returns jobs that do not match given category filters when - # there are matching keywords. For example, the query "program manager," a - # result is returned even if the job posting has the title "software - # developer," which does not fall into "program manager" ontology, but does - # have "program manager" appearing in its description. - # For queries like "cloud" that does not contain title or - # location specific ontology, jobs with "cloud" keyword matches are returned - # regardless of this flag's value. - # Please use Company.keyword_searchable_custom_fields or - # Company.keyword_searchable_custom_attributes if company specific - # globally matched custom field/attribute string values is needed. Enabling - # keyword match improves recall of subsequent search requests. - # Defaults to false. + # Job.description, Job.company_display_name, Job.locations, Job.qualifications. + # When disable keyword match is turned off, a keyword match returns jobs that do + # not match given category filters when there are matching keywords. For example, + # the query "program manager," a result is returned even if the job posting has + # the title "software developer," which does not fall into "program manager" + # ontology, but does have "program manager" appearing in its description. For + # queries like "cloud" that does not contain title or location specific ontology, + # jobs with "cloud" keyword matches are returned regardless of this flag's + # value. Please use Company.keyword_searchable_custom_fields or Company. + # keyword_searchable_custom_attributes if company specific globally matched + # custom field/attribute string values is needed. Enabling keyword match + # improves recall of subsequent search requests. Defaults to false. # Corresponds to the JSON property `disableKeywordMatch` # @return [Boolean] attr_accessor :disable_keyword_match alias_method :disable_keyword_match?, :disable_keyword_match # Optional. Controls whether highly similar jobs are returned next to each other - # in - # the search results. Jobs are identified as highly similar based on - # their titles, job categories, and locations. Highly similar results are - # clustered so that only one representative job of the cluster is - # displayed to the job seeker higher up in the results, with the other jobs - # being displayed lower down in the results. - # Defaults to DiversificationLevel.SIMPLE if no value - # is specified. + # in the search results. Jobs are identified as highly similar based on their + # titles, job categories, and locations. Highly similar results are clustered so + # that only one representative job of the cluster is displayed to the job seeker + # higher up in the results, with the other jobs being displayed lower down in + # the results. Defaults to DiversificationLevel.SIMPLE if no value is specified. # Corresponds to the JSON property `diversificationLevel` # @return [String] attr_accessor :diversification_level # Optional. Controls whether to broaden the search when it produces sparse - # results. - # Broadened queries append results to the end of the matching results - # list. - # Defaults to false. + # results. Broadened queries append results to the end of the matching results + # list. Defaults to false. # Corresponds to the JSON property `enableBroadening` # @return [Boolean] attr_accessor :enable_broadening alias_method :enable_broadening?, :enable_broadening - # Input only. - # Histogram facets to be specified in SearchJobsRequest. + # Input only. Histogram facets to be specified in SearchJobsRequest. # Corresponds to the JSON property `histogramFacets` # @return [Google::Apis::JobsV3::HistogramFacets] attr_accessor :histogram_facets - # Input only. - # The query required to perform a search query. + # Input only. The query required to perform a search query. # Corresponds to the JSON property `jobQuery` # @return [Google::Apis::JobsV3::JobQuery] attr_accessor :job_query - # Optional. The desired job attributes returned for jobs in the - # search response. Defaults to JobView.SMALL if no value is specified. + # Optional. The desired job attributes returned for jobs in the search response. + # Defaults to JobView.SMALL if no value is specified. # Corresponds to the JSON property `jobView` # @return [String] attr_accessor :job_view # Optional. An integer that specifies the current offset (that is, starting - # result - # location, amongst the jobs deemed by the API as relevant) in search - # results. This field is only considered if page_token is unset. - # The maximum allowed value is 5000. Otherwise an error is thrown. - # For example, 0 means to return results starting from the first matching - # job, and 10 means to return from the 11th job. This can be used for - # pagination, (for example, pageSize = 10 and offset = 10 means to return - # from the second page). + # result location, amongst the jobs deemed by the API as relevant) in search + # results. This field is only considered if page_token is unset. The maximum + # allowed value is 5000. Otherwise an error is thrown. For example, 0 means to + # return results starting from the first matching job, and 10 means to return + # from the 11th job. This can be used for pagination, (for example, pageSize = + # 10 and offset = 10 means to return from the second page). # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # Optional. The criteria determining how search results are sorted. Default is - # "relevance desc". - # Supported options are: - # * `"relevance desc"`: By relevance descending, as determined by the API - # algorithms. Relevance thresholding of query results is only available - # with this ordering. - # * `"posting_publish_time desc"`: By Job.posting_publish_time - # descending. - # * `"posting_update_time desc"`: By Job.posting_update_time - # descending. - # * `"title"`: By Job.title ascending. - # * `"title desc"`: By Job.title descending. - # * `"annualized_base_compensation"`: By job's - # CompensationInfo.annualized_base_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_base_compensation desc"`: By job's - # CompensationInfo.annualized_base_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation"`: By job's - # CompensationInfo.annualized_total_compensation_range ascending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. - # * `"annualized_total_compensation desc"`: By job's - # CompensationInfo.annualized_total_compensation_range descending. Jobs - # whose annualized base compensation is unspecified are put at the end of - # search results. + # Optional. The criteria determining how search results are sorted. Default is " + # relevance desc". Supported options are: * `"relevance desc"`: By relevance + # descending, as determined by the API algorithms. Relevance thresholding of + # query results is only available with this ordering. * `"posting_publish_time + # desc"`: By Job.posting_publish_time descending. * `"posting_update_time desc"`: + # By Job.posting_update_time descending. * `"title"`: By Job.title ascending. * + # `"title desc"`: By Job.title descending. * `"annualized_base_compensation"`: + # By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs + # whose annualized base compensation is unspecified are put at the end of search + # results. * `"annualized_base_compensation desc"`: By job's CompensationInfo. + # annualized_base_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation"`: By job's CompensationInfo. + # annualized_total_compensation_range ascending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. * `" + # annualized_total_compensation desc"`: By job's CompensationInfo. + # annualized_total_compensation_range descending. Jobs whose annualized base + # compensation is unspecified are put at the end of search results. # Corresponds to the JSON property `orderBy` # @return [String] attr_accessor :order_by # Optional. A limit on the number of jobs returned in the search results. @@ -2549,39 +2350,31 @@ # response time. The value can be between 1 and 100. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # Optional. The token specifying the current offset within - # search results. See SearchJobsResponse.next_page_token for - # an explanation of how to obtain the next set of query results. + # Optional. The token specifying the current offset within search results. See + # SearchJobsResponse.next_page_token for an explanation of how to obtain the + # next set of query results. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # Input only. - # Meta information related to the job searcher or entity - # conducting the job search. This information is used to improve the - # performance of the service. + # Input only. Meta information related to the job searcher or entity conducting + # the job search. This information is used to improve the performance of the + # service. # Corresponds to the JSON property `requestMetadata` # @return [Google::Apis::JobsV3::RequestMetadata] attr_accessor :request_metadata - # Optional. Controls if the search job request requires the return of a precise - # count of the first 300 results. Setting this to `true` ensures - # consistency in the number of results per page. Best practice is to set this - # value to true if a client allows users to jump directly to a - # non-sequential search results page. - # Enabling this flag may adversely impact performance. - # Defaults to false. + # This field is deprecated. # Corresponds to the JSON property `requirePreciseResultSize` # @return [Boolean] attr_accessor :require_precise_result_size alias_method :require_precise_result_size?, :require_precise_result_size - # Optional. Mode of a search. - # Defaults to SearchMode.JOB_SEARCH. + # Optional. Mode of a search. Defaults to SearchMode.JOB_SEARCH. # Corresponds to the JSON property `searchMode` # @return [String] attr_accessor :search_mode def initialize(**args) @@ -2604,73 +2397,68 @@ @require_precise_result_size = args[:require_precise_result_size] if args.key?(:require_precise_result_size) @search_mode = args[:search_mode] if args.key?(:search_mode) end end - # Output only. - # Response for SearchJob method. + # Output only. Response for SearchJob method. class SearchJobsResponse include Google::Apis::Core::Hashable # If query broadening is enabled, we may append additional results from the # broadened query. This number indicates how many of the jobs returned in the - # jobs field are from the broadened query. These results are always at the - # end of the jobs list. In particular, a value of 0, or if the field isn't - # set, all the jobs in the jobs list are from the original - # (without broadening) query. If this field is non-zero, subsequent requests - # with offset after this result set should contain all broadened results. + # jobs field are from the broadened query. These results are always at the end + # of the jobs list. In particular, a value of 0, or if the field isn't set, all + # the jobs in the jobs list are from the original (without broadening) query. If + # this field is non-zero, subsequent requests with offset after this result set + # should contain all broadened results. # Corresponds to the JSON property `broadenedQueryJobsCount` # @return [Fixnum] attr_accessor :broadened_query_jobs_count - # An estimation of the number of jobs that match the specified query. - # This number is not guaranteed to be accurate. For accurate results, - # see enable_precise_result_size. + # An estimation of the number of jobs that match the specified query. This + # number is not guaranteed to be accurate. For accurate results, see + # SearchJobsResponse.total_size. # Corresponds to the JSON property `estimatedTotalSize` # @return [Fixnum] attr_accessor :estimated_total_size - # Output only. - # Histogram results that match HistogramFacets specified in + # Output only. Histogram results that match HistogramFacets specified in # SearchJobsRequest. # Corresponds to the JSON property `histogramResults` # @return [Google::Apis::JobsV3::HistogramResults] attr_accessor :histogram_results - # The location filters that the service applied to the specified query. If - # any filters are lat-lng based, the JobLocation.location_type is - # JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + # The location filters that the service applied to the specified query. If any + # filters are lat-lng based, the JobLocation.location_type is JobLocation. + # LocationType#LOCATION_TYPE_UNSPECIFIED. # Corresponds to the JSON property `locationFilters` # @return [Array<Google::Apis::JobsV3::Location>] attr_accessor :location_filters # The Job entities that match the specified SearchJobsRequest. # Corresponds to the JSON property `matchingJobs` # @return [Array<Google::Apis::JobsV3::MatchingJob>] attr_accessor :matching_jobs - # Output only. - # Additional information returned to client, such as debugging information. + # Output only. Additional information returned to client, such as debugging + # information. # Corresponds to the JSON property `metadata` # @return [Google::Apis::JobsV3::ResponseMetadata] attr_accessor :metadata # The token that specifies the starting position of the next page of results. # This field is empty if there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Output only. - # Spell check result. + # Output only. Spell check result. # Corresponds to the JSON property `spellCorrection` # @return [Google::Apis::JobsV3::SpellingCorrection] attr_accessor :spell_correction - # The precise result count, which is available only if the client set - # enable_precise_result_size to `true`, or if the response - # is the last page of results. Otherwise, the value is `-1`. + # The precise result count with limit 100,000. # Corresponds to the JSON property `totalSize` # @return [Fixnum] attr_accessor :total_size def initialize(**args) @@ -2689,12 +2477,11 @@ @spell_correction = args[:spell_correction] if args.key?(:spell_correction) @total_size = args[:total_size] if args.key?(:total_size) end end - # Output only. - # Spell check result. + # Output only. Spell check result. class SpellingCorrection include Google::Apis::Core::Hashable # Indicates if the query was corrected by the spell checker. # Corresponds to the JSON property `corrected` @@ -2716,18 +2503,18 @@ @corrected = args[:corrected] if args.key?(:corrected) @corrected_text = args[:corrected_text] if args.key?(:corrected_text) end end - # Represents a time of day. The date and time zone are either not significant - # or are specified elsewhere. An API may choose to allow leap seconds. Related + # Represents a time of day. The date and time zone are either not significant or + # are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. class TimeOfDay include Google::Apis::Core::Hashable - # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose - # to allow the value "24:00:00" for scenarios like business closing time. + # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to + # allow the value "24:00:00" for scenarios like business closing time. # Corresponds to the JSON property `hours` # @return [Fixnum] attr_accessor :hours # Minutes of hour of day. Must be from 0 to 59. @@ -2782,28 +2569,25 @@ @end_time = args[:end_time] if args.key?(:end_time) @start_time = args[:start_time] if args.key?(:start_time) end end - # Input only. - # Request for updating a specified company. + # Input only. Request for updating a specified company. class UpdateCompanyRequest include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `company` # @return [Google::Apis::JobsV3::Company] attr_accessor :company - # Optional but strongly recommended for the best service - # experience. - # If update_mask is provided, only the specified fields in - # company are updated. Otherwise all the fields are updated. - # A field mask to specify the company fields to be updated. Only - # top level fields of Company are supported. + # Optional but strongly recommended for the best service experience. If + # update_mask is provided, only the specified fields in company are updated. + # Otherwise all the fields are updated. A field mask to specify the company + # fields to be updated. Only top level fields of Company are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask def initialize(**args) @@ -2815,27 +2599,24 @@ @company = args[:company] if args.key?(:company) @update_mask = args[:update_mask] if args.key?(:update_mask) end end - # Input only. - # Update job request. + # Input only. Update job request. class UpdateJobRequest include Google::Apis::Core::Hashable # A Job resource represents a job posting (also referred to as a "job listing" - # or "job requisition"). A job belongs to a Company, which is the hiring - # entity responsible for the job. + # or "job requisition"). A job belongs to a Company, which is the hiring entity + # responsible for the job. # Corresponds to the JSON property `job` # @return [Google::Apis::JobsV3::Job] attr_accessor :job # Optional but strongly recommended to be provided for the best service - # experience. - # If update_mask is provided, only the specified fields in - # job are updated. Otherwise all the fields are updated. - # A field mask to restrict the fields that are updated. Only - # top level fields of Job are supported. + # experience. If update_mask is provided, only the specified fields in job are + # updated. Otherwise all the fields are updated. A field mask to restrict the + # fields that are updated. Only top level fields of Job are supported. # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask def initialize(**args)