From 2b5f7ed02ba2317ed9f467528e98b6c699a0e1a3 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Fri, 19 Jul 2019 00:38:19 +0000 Subject: [PATCH] Autogenerated update (2019-07-19) Update: - bigquery_v2 - jobs_v2 - jobs_v3 - jobs_v3p1beta1 - people_v1 --- generated/google/apis/bigquery_v2.rb | 2 +- generated/google/apis/bigquery_v2/classes.rb | 7 + .../apis/bigquery_v2/representations.rb | 2 + generated/google/apis/bigquery_v2/service.rb | 2 +- generated/google/apis/jobs_v2.rb | 2 +- generated/google/apis/jobs_v2/classes.rb | 387 +++++++++++------- generated/google/apis/jobs_v2/service.rb | 68 +-- generated/google/apis/jobs_v3.rb | 2 +- generated/google/apis/jobs_v3/classes.rb | 292 +++++-------- generated/google/apis/jobs_v3/service.rb | 75 ++-- generated/google/apis/jobs_v3p1beta1.rb | 2 +- .../google/apis/jobs_v3p1beta1/classes.rb | 306 ++++++-------- .../google/apis/jobs_v3p1beta1/service.rb | 75 ++-- generated/google/apis/people_v1.rb | 2 +- generated/google/apis/people_v1/classes.rb | 105 +++++ .../google/apis/people_v1/representations.rb | 42 ++ generated/google/apis/people_v1/service.rb | 98 +++++ 17 files changed, 826 insertions(+), 643 deletions(-) diff --git a/generated/google/apis/bigquery_v2.rb b/generated/google/apis/bigquery_v2.rb index c600d888b..5c6c41a07 100644 --- a/generated/google/apis/bigquery_v2.rb +++ b/generated/google/apis/bigquery_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/bigquery/ module BigqueryV2 VERSION = 'V2' - REVISION = '20190630' + REVISION = '20190712' # View and manage your data in Google BigQuery AUTH_BIGQUERY = 'https://www.googleapis.com/auth/bigquery' diff --git a/generated/google/apis/bigquery_v2/classes.rb b/generated/google/apis/bigquery_v2/classes.rb index 829fcb54f..4d48dcb5a 100644 --- a/generated/google/apis/bigquery_v2/classes.rb +++ b/generated/google/apis/bigquery_v2/classes.rb @@ -2969,6 +2969,12 @@ module Google # @return [Array] attr_accessor :query_plan + # [Output-only] Referenced routines (persistent user-defined functions and + # stored procedures) for the job. + # Corresponds to the JSON property `referencedRoutines` + # @return [Array] + attr_accessor :referenced_routines + # [Output-only] Referenced tables for the job. Queries that reference more than # 50 tables will not have a complete list. # Corresponds to the JSON property `referencedTables` @@ -3064,6 +3070,7 @@ module Google @model_training_expected_total_iteration = args[:model_training_expected_total_iteration] if args.key?(:model_training_expected_total_iteration) @num_dml_affected_rows = args[:num_dml_affected_rows] if args.key?(:num_dml_affected_rows) @query_plan = args[:query_plan] if args.key?(:query_plan) + @referenced_routines = args[:referenced_routines] if args.key?(:referenced_routines) @referenced_tables = args[:referenced_tables] if args.key?(:referenced_tables) @reservation_usage = args[:reservation_usage] if args.key?(:reservation_usage) @schema = args[:schema] if args.key?(:schema) diff --git a/generated/google/apis/bigquery_v2/representations.rb b/generated/google/apis/bigquery_v2/representations.rb index 5d75deb0a..98dac837d 100644 --- a/generated/google/apis/bigquery_v2/representations.rb +++ b/generated/google/apis/bigquery_v2/representations.rb @@ -1288,6 +1288,8 @@ module Google property :num_dml_affected_rows, :numeric_string => true, as: 'numDmlAffectedRows' collection :query_plan, as: 'queryPlan', class: Google::Apis::BigqueryV2::ExplainQueryStage, decorator: Google::Apis::BigqueryV2::ExplainQueryStage::Representation + collection :referenced_routines, as: 'referencedRoutines', class: Google::Apis::BigqueryV2::RoutineReference, decorator: Google::Apis::BigqueryV2::RoutineReference::Representation + collection :referenced_tables, as: 'referencedTables', class: Google::Apis::BigqueryV2::TableReference, decorator: Google::Apis::BigqueryV2::TableReference::Representation collection :reservation_usage, as: 'reservationUsage', class: Google::Apis::BigqueryV2::JobStatistics2::ReservationUsage, decorator: Google::Apis::BigqueryV2::JobStatistics2::ReservationUsage::Representation diff --git a/generated/google/apis/bigquery_v2/service.rb b/generated/google/apis/bigquery_v2/service.rb index 51fbf4e03..016568901 100644 --- a/generated/google/apis/bigquery_v2/service.rb +++ b/generated/google/apis/bigquery_v2/service.rb @@ -47,7 +47,7 @@ module Google attr_accessor :user_ip def initialize - super('https://bigquery.googleapis.com/', 'bigquery/v2/') + super('https://www.googleapis.com/', 'bigquery/v2/') @batch_path = 'batch/bigquery/v2' end diff --git a/generated/google/apis/jobs_v2.rb b/generated/google/apis/jobs_v2.rb index f493d85a2..84ecd8fb1 100644 --- a/generated/google/apis/jobs_v2.rb +++ b/generated/google/apis/jobs_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV2 VERSION = 'V2' - REVISION = '20190712' + REVISION = '20190713' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v2/classes.rb b/generated/google/apis/jobs_v2/classes.rb index 3f4883c35..c83d7660e 100644 --- a/generated/google/apis/jobs_v2/classes.rb +++ b/generated/google/apis/jobs_v2/classes.rb @@ -27,7 +27,8 @@ module Google class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. The filter string specifies the jobs to be deleted. + # Required. + # The filter string specifies the jobs to be deleted. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -133,7 +134,8 @@ module Google class CommutePreference include Google::Apis::Core::Hashable - # Optional. If `true`, jobs without street level addresses may also be returned. + # Optional. + # If `true`, jobs without street level addresses may also be returned. # For city level addresses, the city center is used. For state and coarser # level addresses, text matching is used. # If this field is set to `false` or is not specified, only jobs that include @@ -143,19 +145,22 @@ module Google attr_accessor :allow_non_street_level_address alias_method :allow_non_street_level_address?, :allow_non_street_level_address - # Optional. The departure hour to use to calculate traffic impact. Accepts an + # Optional. + # The departure hour to use to calculate traffic impact. Accepts an # integer between 0 and 23, representing the hour in the time zone of the # start_location. Must not be present if road_traffic is specified. # Corresponds to the JSON property `departureHourLocal` # @return [Fixnum] attr_accessor :departure_hour_local - # Required. The method of transportation for which to calculate the commute time. + # Required. + # The method of transportation for which to calculate the commute time. # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop - # Optional. Specifies the traffic density to use when calculating commute time. + # Optional. + # Specifies the traffic density to use when calculating commute time. # Must not be present if departure_hour_local is specified. # Corresponds to the JSON property `roadTraffic` # @return [String] @@ -170,8 +175,8 @@ module Google # @return [Google::Apis::JobsV2::LatLng] attr_accessor :start_location - # Required. The maximum travel time in seconds. The maximum allowed value is ` - # 3600s` + # Required. + # The maximum travel time in seconds. The maximum allowed value is `3600s` # (one hour). Format is `123s`. # Corresponds to the JSON property `travelTime` # @return [String] @@ -198,21 +203,22 @@ module Google class Company include Google::Apis::Core::Hashable - # Optional. The URL to employer's career site or careers page on the employer's - # web + # Optional. + # The URL to employer's career site or careers page on the employer's web # site. # Corresponds to the JSON property `careerPageLink` # @return [String] attr_accessor :career_page_link - # Optional. Identifiers external to the application that help to further - # identify + # Optional. + # Identifiers external to the application that help to further identify # the employer. # Corresponds to the JSON property `companyInfoSources` # @return [Array] attr_accessor :company_info_sources - # Optional. The employer's company size. + # Optional. + # The employer's company size. # Corresponds to the JSON property `companySize` # @return [String] attr_accessor :company_size @@ -225,13 +231,15 @@ module Google attr_accessor :disable_location_optimization alias_method :disable_location_optimization?, :disable_location_optimization - # Required. The name of the employer to be displayed with the job, + # Required. + # The name of the employer to be displayed with the job, # for example, "Google, LLC.". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Optional. The unique company identifier provided by the client to identify an + # Optional. + # The unique company identifier provided by the client to identify an # employer for billing purposes. Recommended practice is to use # the distributor_company_id. # Defaults to same value as distributor_company_id when a value @@ -240,7 +248,8 @@ module Google # @return [String] attr_accessor :distributor_billing_company_id - # Required. A client's company identifier, used to uniquely identify the + # Required. + # A client's company identifier, used to uniquely identify the # company. If an employer has a subsidiary or sub-brand, such as "Alphabet" # and "Google", which the client wishes to use as the company displayed on # the job. Best practice is to create a distinct company identifier for each @@ -250,7 +259,8 @@ module Google # @return [String] attr_accessor :distributor_company_id - # Optional. Equal Employment Opportunity legal disclaimer text to be + # 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. @@ -258,7 +268,8 @@ module Google # @return [String] attr_accessor :eeo_text - # Optional. Set to true if it is the hiring agency that post jobs for other + # Optional. + # Set to true if it is the hiring agency that post jobs for other # employers. # Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` @@ -266,7 +277,8 @@ module Google attr_accessor :hiring_agency alias_method :hiring_agency?, :hiring_agency - # Optional. The street address of the company's main headquarters, which may be + # 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 structured_company_hq_location. @@ -274,7 +286,8 @@ module Google # @return [String] attr_accessor :hq_location - # Optional. A URL that hosts the employer's company logo. If provided, + # Optional. + # A URL that hosts the employer's company logo. If provided, # the logo image should be squared at 80x80 pixels. # The url must be a Google Photos or Google Album url. # Only images in these Google sub-domains are accepted. @@ -282,7 +295,8 @@ module Google # @return [String] attr_accessor :image_url - # Optional. A list of keys of filterable Job.custom_attributes, whose + # 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 @@ -318,8 +332,8 @@ module Google # @return [Google::Apis::JobsV2::JobLocation] attr_accessor :structured_company_hq_location - # Output only. Indicates whether a company is flagged to be suspended from - # public + # Output only. + # Indicates whether a company is flagged to be suspended from public # availability by the service when job content appears suspicious, # abusive, or spammy. # Corresponds to the JSON property `suspended` @@ -335,7 +349,8 @@ module Google # @return [String] attr_accessor :title - # Optional. The URL representing the company's primary web site or home page, + # Optional. + # The URL representing the company's primary web site or home page, # such as, "www.google.com". # Corresponds to the JSON property `website` # @return [String] @@ -374,24 +389,27 @@ module Google class CompanyInfoSource include Google::Apis::Core::Hashable - # Optional. The Google's Knowledge Graph value for the employer's company. + # Optional. + # The Google's Knowledge Graph value for the employer's company. # Corresponds to the JSON property `freebaseMid` # @return [String] attr_accessor :freebase_mid - # Optional. The numeric identifier for the employer's Google+ business page. + # Optional. + # The numeric identifier for the employer's Google+ business page. # Corresponds to the JSON property `gplusId` # @return [String] attr_accessor :gplus_id - # Optional. The numeric identifier for the employer's headquarters on Google - # Maps, + # Optional. + # The numeric identifier for the employer's headquarters on Google Maps, # namely, the Google Maps CID (cell id). # Corresponds to the JSON property `mapsCid` # @return [String] attr_accessor :maps_cid - # Optional. A Google identifier that does not match any of the other types. + # Optional. + # A Google identifier that does not match any of the other types. # Corresponds to the JSON property `unknownTypeId` # @return [String] attr_accessor :unknown_type_id @@ -424,14 +442,16 @@ module Google # @return [Google::Apis::JobsV2::Money] attr_accessor :amount - # Optional. Compensation description. For example, could + # 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 + # 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 @@ -448,12 +468,14 @@ module Google # @return [Google::Apis::JobsV2::CompensationRange] attr_accessor :range - # Required. Compensation type. + # Required. + # Compensation type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. + # Optional. + # Frequency of the specified amount. # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] @@ -479,7 +501,8 @@ module Google class CompensationFilter include Google::Apis::Core::Hashable - # Optional. Whether to include jobs whose compensation range is unspecified. + # Optional. + # Whether to include jobs whose compensation range is unspecified. # Corresponds to the JSON property `includeJobsWithUnspecifiedCompensationRange` # @return [Boolean] attr_accessor :include_jobs_with_unspecified_compensation_range @@ -490,12 +513,14 @@ module Google # @return [Google::Apis::JobsV2::CompensationRange] attr_accessor :range - # Required. Type of filter. + # Required. + # Type of filter. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Required. Specify desired `base compensation entry's` + # Required. + # Specify desired `base compensation entry's` # CompensationInfo.CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] @@ -525,8 +550,8 @@ module Google # @return [Google::Apis::JobsV2::NumericBucketingOption] attr_accessor :bucketing_option - # Required. Type of the request, representing which field the histogramming - # should be + # 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`. # Corresponds to the JSON property `type` @@ -591,7 +616,8 @@ module Google # @return [Google::Apis::JobsV2::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. Job compensation information. + # 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. @@ -761,7 +787,8 @@ module Google class CustomAttribute include Google::Apis::Core::Hashable - # Optional. If the `filterable` flag is true, custom field values are searchable. + # Optional. + # If the `filterable` flag is true, custom field values are searchable. # If false, values are not searchable. # Default is false. # Corresponds to the JSON property `filterable` @@ -801,8 +828,8 @@ module Google class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable - # Required. Specifies the custom field key to perform a histogram on. If - # specified + # 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. @@ -873,7 +900,8 @@ module Google class CustomField include Google::Apis::Core::Hashable - # Optional. The values of the custom data. + # Optional. + # The values of the custom data. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -893,12 +921,14 @@ module Google class CustomFieldFilter include Google::Apis::Core::Hashable - # Required. The query strings for the filter. + # Required. + # The query strings for the filter. # Corresponds to the JSON property `queries` # @return [Array] attr_accessor :queries - # Optional. The type of filter. + # Optional. + # The type of filter. # Defaults to FilterType.OR. # Corresponds to the JSON property `type` # @return [String] @@ -965,7 +995,8 @@ module Google class DeleteJobsByFilterRequest include Google::Apis::Core::Hashable - # Optional. If set to true, this call waits for all processing steps to complete + # Optional. + # If set to true, this call waits for all processing steps to complete # before the job is cleaned up. Otherwise, the call returns while some # steps are still taking place asynchronously, hence faster. # Corresponds to the JSON property `disableFastProcess` @@ -998,13 +1029,14 @@ module Google class DeviceInfo include Google::Apis::Core::Hashable - # Optional. Type of the device. + # Optional. + # Type of the device. # Corresponds to the JSON property `deviceType` # @return [String] attr_accessor :device_type - # Optional. A device-specific ID. The ID must be a unique identifier that - # distinguishes + # Optional. + # A device-specific ID. The ID must be a unique identifier that distinguishes # the device from other devices. # Corresponds to the JSON property `id` # @return [String] @@ -1052,26 +1084,30 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :compensation_range - # Required. Specify desired `base compensation entry's` + # Required. + # Specify desired `base compensation entry's` # ExtendedCompensationInfo.CompensationUnit. # Corresponds to the JSON property `compensationUnits` # @return [Array] attr_accessor :compensation_units - # Optional. Specify currency in 3-letter + # Optional. + # Specify currency in 3-letter # [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If # unspecified, jobs are returned regardless of currency. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency - # Optional. Whether to include jobs whose compensation range is unspecified. + # Optional. + # Whether to include jobs whose compensation range is unspecified. # Corresponds to the JSON property `includeJobWithUnspecifiedCompensationRange` # @return [Boolean] attr_accessor :include_job_with_unspecified_compensation_range alias_method :include_job_with_unspecified_compensation_range?, :include_job_with_unspecified_compensation_range - # Required. Type of filter. + # Required. + # Type of filter. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1101,8 +1137,8 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :annualized_base_compensation_range - # Output only. Indicates annualized base compensation range cannot be derived, - # due to + # Output only. + # Indicates annualized base compensation range cannot be derived, due to # the job's base compensation entry cannot be annualized. # See CompensationEntry for explanation on annualization and base # compensation entry. @@ -1117,8 +1153,8 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :annualized_total_compensation_range - # Output only. Indicates annualized total compensation range cannot be derived, - # due to + # Output only. + # Indicates annualized total compensation range cannot be derived, due to # the job's all CompensationEntry cannot be annualized. # See CompensationEntry for explanation on annualization and base # compensation entry. @@ -1127,14 +1163,15 @@ module Google attr_accessor :annualized_total_compensation_unspecified alias_method :annualized_total_compensation_unspecified?, :annualized_total_compensation_unspecified - # Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes. - # html) + # Optional. + # A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) # currency code. # Corresponds to the JSON property `currency` # @return [String] attr_accessor :currency - # Optional. Job compensation information. + # Optional. + # Job compensation information. # At most one entry can be of type # ExtendedCompensationInfo.CompensationType.BASE, which is # referred as ** base compensation entry ** for the job. @@ -1174,7 +1211,8 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationInfoDecimal] attr_accessor :amount - # Optional. Compensation description. + # Optional. + # Compensation description. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1191,18 +1229,21 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationInfoCompensationRange] attr_accessor :range - # Required. Compensation type. + # Required. + # Compensation type. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Optional. Frequency of the specified amount. + # Optional. + # Frequency of the specified amount. # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] attr_accessor :unit - # Optional. Indicates compensation amount and range are unset. + # Optional. + # Indicates compensation amount and range are unset. # Corresponds to the JSON property `unspecified` # @return [Boolean] attr_accessor :unspecified @@ -1289,8 +1330,8 @@ module Google class Filter include Google::Apis::Core::Hashable - # Required. The requisition ID (or posting ID) assigned by the client to - # identify a + # Required. + # The requisition ID (or posting ID) assigned by the client to identify a # job. This is intended for client identification and tracking of # listings. # name takes precedence over this field @@ -1316,8 +1357,8 @@ module Google class GetHistogramRequest include Google::Apis::Core::Hashable - # Optional. Controls whether to broaden the search to avoid too few results for - # a + # Optional. + # Controls whether to broaden the search to avoid too few results for a # given query in instances where a search has sparse results. Results from a # broadened query is a superset of the results from the original query. # Defaults to false. @@ -1347,7 +1388,8 @@ module Google # @return [Google::Apis::JobsV2::RequestMetadata] attr_accessor :request_metadata - # Required. A list of facets that specify the histogram data to be calculated + # Required. + # A list of facets that specify the histogram data to be calculated # against and returned. # Histogram response times can be slow, and counts # can be approximations. This call may be temporarily or permanently removed @@ -1405,13 +1447,15 @@ module Google class HistogramFacets include Google::Apis::Core::Hashable - # Optional. Specifies compensation field-based histogram requests. + # Optional. + # Specifies compensation field-based histogram requests. # Duplicate values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. Specifies the custom attributes histogram requests. + # Optional. + # Specifies the custom attributes histogram requests. # Duplicate values of CustomAttributeHistogramRequest.key are not # allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` @@ -1543,12 +1587,14 @@ module Google # @return [Array] attr_accessor :application_urls - # Optional. The benefits included with the job. + # Optional. + # The benefits included with the job. # Corresponds to the JSON property `benefits` # @return [Array] attr_accessor :benefits - # Output only. The name of the company listing the job. + # Output only. + # The name of the company listing the job. # Corresponds to the JSON property `companyDisplayName` # @return [String] attr_accessor :company_display_name @@ -1574,13 +1620,14 @@ module Google # @return [Google::Apis::JobsV2::CompensationInfo] attr_accessor :compensation_info - # Output only. The timestamp when this job was created. + # Output only. + # The timestamp when this job was created. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Optional. A map of fields to hold both filterable and non-filterable custom - # job + # Optional. + # A map of fields to hold both filterable and non-filterable custom job # attributes that are not covered by the provided structured fields. # This field is a more general combination of the deprecated id-based # filterable_custom_fields and string-based @@ -1596,15 +1643,16 @@ module Google # @return [Hash] attr_accessor :custom_attributes - # Optional. The department or functional area within the company with the open + # Optional. + # The department or functional area within the company with the open # position. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` # @return [String] attr_accessor :department - # Required. The description of the job, which typically includes a multi- - # paragraph + # 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 @@ -1626,13 +1674,15 @@ module Google # @return [String] attr_accessor :distributor_company_id - # Optional. The desired education level for the job, such as + # Optional. + # The desired education level for the job, such as # "Bachelors", "Masters", "Doctorate". # Corresponds to the JSON property `educationLevels` # @return [Array] attr_accessor :education_levels - # Optional. The employment type(s) of a job, for example, + # Optional. + # The employment type(s) of a job, for example, # full time or # part time. # Corresponds to the JSON property `employmentTypes` @@ -1723,25 +1773,29 @@ module Google # @return [Hash] attr_accessor :filterable_custom_fields - # Optional. A description of bonus, commission, and other compensation + # 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. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives - # Output only. Structured locations of the job, resolved from locations. + # Output only. + # Structured locations of the job, resolved from locations. # Corresponds to the JSON property `jobLocations` # @return [Array] attr_accessor :job_locations - # Required. The title of the job, such as "Software Engineer" + # Required. + # The title of the job, such as "Software Engineer" # The maximum number of allowed characters is 500. # Corresponds to the JSON property `jobTitle` # @return [String] attr_accessor :job_title - # Optional. The language of the posting. This field is distinct from + # 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 @@ -1754,7 +1808,8 @@ module Google # @return [String] attr_accessor :language_code - # Optional. The experience level associated with the job, such as "Entry Level". + # Optional. + # The experience level associated with the job, such as "Entry Level". # Corresponds to the JSON property `level` # @return [String] attr_accessor :level @@ -1784,7 +1839,8 @@ module Google # @return [String] attr_accessor :name - # Optional. A promotion value of the job, as determined by the client. + # 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 @@ -1806,7 +1862,8 @@ module Google # @return [Google::Apis::JobsV2::Date] attr_accessor :publish_date - # Optional. A description of the qualifications required to perform the + # 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 @@ -1816,13 +1873,14 @@ module Google # @return [String] attr_accessor :qualifications - # Output only. The URL of a web page that displays job details. + # Output only. + # The URL of a web page that displays job details. # Corresponds to the JSON property `referenceUrl` # @return [String] attr_accessor :reference_url - # Optional. The job Region (for example, state, country) throughout which the - # job + # Optional. + # The job Region (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 if an exact location match is not specified. @@ -1832,8 +1890,8 @@ module Google # @return [String] attr_accessor :region - # Required. The requisition ID, also referred to as the posting ID, assigned by - # the + # 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 listings. A job is not allowed # to be created if there is another job with the same requisition_id, @@ -1843,7 +1901,8 @@ module Google # @return [String] attr_accessor :requisition_id - # Optional. A description of job responsibilities. The use of this field is + # 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 @@ -1876,12 +1935,14 @@ module Google # @return [Hash] attr_accessor :unindexed_custom_fields - # Output only. The timestamp when this job was last updated. + # Output only. + # The timestamp when this job was last updated. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time - # Optional. The visibility of the job. + # Optional. + # The visibility of the job. # Defaults to JobVisibility.PRIVATE if not specified. # Currently only JobVisibility.PRIVATE is supported. # Corresponds to the JSON property `visibility` @@ -1941,8 +2002,8 @@ module Google class JobFilters include Google::Apis::Core::Hashable - # Optional. The category filter specifies the categories of jobs to search - # against. + # 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 @@ -1957,7 +2018,8 @@ module Google # @return [Google::Apis::JobsV2::CommutePreference] attr_accessor :commute_filter - # Optional. The company names filter specifies the company entities to search + # Optional. + # The company names filter specifies the company entities to search # against. # If a value is not specified, jobs are searched for against all companies. # If multiple values are specified, jobs are searched against the @@ -1967,7 +2029,8 @@ module Google # @return [Array] attr_accessor :company_names - # Optional. This filter specifies the exact company titles + # Optional. + # This filter specifies the exact company titles # of jobs to search against. # If a value is not specified, jobs within the search results can be # associated with any company. @@ -1984,7 +2047,8 @@ module Google # @return [Google::Apis::JobsV2::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the + # Optional. + # This filter specifies a structured syntax to match against the # Job.custom_attributes that are marked as `filterable`. # The syntax for this expression is a subset of Google SQL syntax. # Supported operators are: =, !=, <, <=, >, >= where the left of the operator @@ -2015,7 +2079,8 @@ module Google # @return [Hash] attr_accessor :custom_field_filters - # Optional. This flag controls the spell-check feature. If false, the + # 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. @@ -2024,7 +2089,8 @@ module Google 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 + # 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 include any # employment type. @@ -2041,7 +2107,8 @@ module Google # @return [Google::Apis::JobsV2::ExtendedCompensationFilter] attr_accessor :extended_compensation_filter - # Optional. This filter specifies the locale of jobs to search against, + # Optional. + # This filter specifies the locale of jobs to search against, # for example, "en-US". # If a value is not specified, the search results may contain jobs in any # locale. @@ -2053,7 +2120,8 @@ module Google # @return [Array] attr_accessor :language_codes - # Optional. The location filter specifies geo-regions containing the jobs to + # Optional. + # The location filter specifies geo-regions containing the jobs to # search against. See LocationFilter for more information. # If a location value is not specified, jobs are retrieved # from all locations. @@ -2066,7 +2134,8 @@ module Google # @return [Array] attr_accessor :location_filters - # Optional. Jobs published within a range specified by this filter are searched + # Optional. + # Jobs published within a range specified by this filter are searched # against, for example, DateRange.PAST_MONTH. If a value is not # specified, all open jobs are searched against regardless of the # date they were published. @@ -2074,7 +2143,8 @@ module Google # @return [String] attr_accessor :publish_date_range - # Optional. The query filter contains the keywords that match against the job + # Optional. + # The query filter contains the keywords that match against the job # title, description, and location fields. # The maximum query size is 255 bytes/characters. # Corresponds to the JSON property `query` @@ -2147,7 +2217,7 @@ module Google # 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) + # https://github.com/googlei18n/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: @@ -2183,14 +2253,16 @@ module Google class JobProcessingOptions include Google::Apis::Core::Hashable - # Optional. If set to `true`, the service does not attempt to resolve a + # 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: + # Optional. + # Option for job HTML content sanitization. Applied fields are: # * description # * applicationInstruction # * incentives @@ -2218,8 +2290,8 @@ module Google class JobQuery include Google::Apis::Core::Hashable - # Optional. The category filter specifies the categories of jobs to search - # against. + # 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 @@ -2234,7 +2306,8 @@ module Google # @return [Google::Apis::JobsV2::CommutePreference] attr_accessor :commute_filter - # Optional. This filter specifies the exact company display + # 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. @@ -2245,7 +2318,8 @@ module Google # @return [Array] attr_accessor :company_display_names - # Optional. This filter specifies the company entities to search against. + # 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 @@ -2261,7 +2335,8 @@ module Google # @return [Google::Apis::JobsV2::CompensationFilter] attr_accessor :compensation_filter - # Optional. This filter specifies a structured syntax to match against the + # 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 Google SQL syntax. # Supported operators are: =, !=, <, <=, >, >= where the left of the operator @@ -2280,7 +2355,8 @@ module Google # @return [String] attr_accessor :custom_attribute_filter - # Optional. This flag controls the spell-check feature. If false, the + # 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. @@ -2289,7 +2365,8 @@ module Google 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 + # 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 include any # employment type. @@ -2299,7 +2376,8 @@ module Google # @return [Array] attr_accessor :employment_types - # Optional. This filter specifies the locale of jobs to search against, + # 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. @@ -2311,7 +2389,8 @@ module Google # @return [Array] attr_accessor :language_codes - # Optional. The location filter specifies geo-regions containing the jobs to + # 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. @@ -2324,7 +2403,8 @@ module Google # @return [Array] attr_accessor :location_filters - # Optional. Jobs published within a range specified by this filter are searched + # Optional. + # Jobs published within a range specified by this filter are searched # against, for example, DateRange.PAST_MONTH. If a value isn't # specified, all open jobs are searched against regardless of their # published date. @@ -2332,8 +2412,8 @@ module Google # @return [String] attr_accessor :publish_date_range - # Optional. The query string that matches against the job title, description, - # and + # Optional. + # The query string that matches against the job title, description, and # location fields. # The maximum query size is 255 bytes. # Corresponds to the JSON property `query` @@ -2510,15 +2590,16 @@ module Google class LocationFilter include Google::Apis::Core::Hashable - # Optional. The distance_in_miles is applied when the location being searched - # for is + # 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. # Corresponds to the JSON property `distanceInMiles` # @return [Float] attr_accessor :distance_in_miles - # Optional. Allows the client to return jobs without a + # Optional. + # Allows the client to return jobs without a # set location, specifically, telecommuting jobs (telecomuting is considered # by the service as a special location. # Job.allow_telecommute indicates if a job permits telecommuting. @@ -2545,13 +2626,14 @@ module Google # @return [Google::Apis::JobsV2::LatLng] attr_accessor :lat_lng - # Optional. The address name, such as "Mountain View" or "Bay Area". + # Optional. + # The address name, such as "Mountain View" or "Bay Area". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. CLDR region code of the country/region of the address. This will be - # used + # Optional. + # CLDR region code of the country/region of the address. This will be used # to address ambiguity of the user-input location, e.g. "Liverpool" # against "Liverpool, NY, US" or "Liverpool, UK". # Set this field if all the jobs to search against are from a same region, @@ -2672,7 +2754,8 @@ module Google class NumericBucketingOption include Google::Apis::Core::Hashable - # Required. Two adjacent values form a histogram bucket. Values should be in + # 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. @@ -2680,7 +2763,8 @@ module Google # @return [Array] attr_accessor :bucket_bounds - # Optional. If set to true, the histogram result includes minimum/maximum + # Optional. + # If set to true, the histogram result includes minimum/maximum # value of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] @@ -2742,7 +2826,7 @@ module Google # 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) + # https://github.com/googlei18n/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: @@ -2892,8 +2976,8 @@ module Google # @return [Google::Apis::JobsV2::DeviceInfo] attr_accessor :device_info - # Required. The client-defined scope or source of the service call, which - # typically + # 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 Foo, Inc., on @@ -2907,7 +2991,8 @@ module Google # @return [String] attr_accessor :domain - # Required. A unique session identification string. A session is defined as the + # Required. + # A unique session identification string. A session is defined as the # duration of an end user's interaction with the service over a period. # Obfuscate this field for privacy concerns before # providing it to the API. @@ -2918,8 +3003,8 @@ module Google # @return [String] attr_accessor :session_id - # Required. A unique user identification string, as determined by the client. - # The + # Required. + # A unique user identification string, as determined by the client. The # client is responsible for ensuring client-level uniqueness of this value # in order to have the strongest positive impact on search quality. # Obfuscate this field for privacy concerns before @@ -2986,7 +3071,8 @@ module Google class SearchJobsRequest include Google::Apis::Core::Hashable - # Optional. Controls whether to disable relevance thresholding. Relevance + # Optional. + # Controls whether to disable relevance thresholding. Relevance # thresholding removes jobs that have low relevance in search results, # for example, removing "Assistant to the CEO" positions from the search # results of a search for "CEO". @@ -2998,8 +3084,8 @@ module Google attr_accessor :disable_relevance_thresholding alias_method :disable_relevance_thresholding?, :disable_relevance_thresholding - # Optional. Controls whether to broaden the search when it produces sparse - # results. + # 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. @@ -3008,7 +3094,8 @@ module Google attr_accessor :enable_broadening alias_method :enable_broadening?, :enable_broadening - # Optional. Controls if the search job request requires the return of a precise + # 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 @@ -3033,19 +3120,21 @@ module Google # @return [Google::Apis::JobsV2::HistogramFacets] attr_accessor :histogram_facets - # Optional. The number of job attributes returned for jobs in the + # Optional. + # The number of 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 - # Required. Mode of a search. + # Required. + # Mode of a search. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode - # Optional. An integer that specifies the current offset (that is, starting - # result + # 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. # For example, 0 means to return results starting from the first matching @@ -3064,14 +3153,16 @@ module Google # @return [String] attr_accessor :order_by - # Optional. A limit on the number of jobs returned in the search results. + # Optional. + # A limit on the number of jobs returned in the search results. # Increasing this value above the default value of 10 can increase search # 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 + # 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` @@ -3092,7 +3183,8 @@ module Google # @return [Google::Apis::JobsV2::RequestMetadata] attr_accessor :request_metadata - # Optional. The criteria determining how search results are sorted. + # Optional. + # The criteria determining how search results are sorted. # Defaults to SortBy.RELEVANCE_DESC if no value is specified. # Corresponds to the JSON property `sortBy` # @return [String] @@ -3251,7 +3343,8 @@ module Google class StringValues include Google::Apis::Core::Hashable - # Required. String values. + # Required. + # String values. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values diff --git a/generated/google/apis/jobs_v2/service.rb b/generated/google/apis/jobs_v2/service.rb index 5ba18c630..97907d3a9 100644 --- a/generated/google/apis/jobs_v2/service.rb +++ b/generated/google/apis/jobs_v2/service.rb @@ -80,7 +80,8 @@ module Google # Deletes the specified company. # @param [String] name - # Required. The resource name of the company to be deleted, + # Required. + # The resource name of the company to be deleted, # such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -111,7 +112,8 @@ module Google # Retrieves the specified company. # @param [String] name - # Required. Resource name of the company to retrieve, + # Required. + # Resource name of the company to retrieve, # such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -142,15 +144,18 @@ module Google # Lists all companies associated with a Cloud Talent Solution account. # @param [Boolean] must_have_open_jobs - # Optional. Set to true if the companies request must have open jobs. + # Optional. + # Set to true if the companies request must have open jobs. # Defaults to false. # If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. # @param [Fixnum] page_size - # Optional. The maximum number of companies to be returned, at most 100. + # Optional. + # The maximum number of companies to be returned, at most 100. # Default is 100 if a non-positive number is provided. # @param [String] page_token - # Optional. The starting indicator from which to return results. + # Optional. + # The starting indicator from which to return results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -241,11 +246,12 @@ module Google # Deprecated. Use ListJobs instead. # Lists all jobs associated with a company. # @param [String] company_name - # Required. The resource name of the company that owns the jobs to be listed, + # Required. + # The resource name of the company that owns the jobs to be listed, # such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". # @param [Boolean] ids_only - # Optional. If set to `true`, only job ID, job requisition ID and language code - # will be + # Optional. + # If set to `true`, only job ID, job requisition ID and language code will be # returned. # A typical use is to synchronize job repositories. # Defaults to false. @@ -256,17 +262,19 @@ module Google # Set to true if the total number of open jobs is to be returned. # Defaults to false. # @param [String] job_requisition_id - # Optional. The requisition ID, also known as posting ID, assigned by the - # company + # Optional. + # The requisition ID, also known as posting ID, assigned by the company # to the job. # The maximum number of allowable characters is 225. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. + # Optional. + # The maximum number of jobs to be returned per page of results. # If ids_only is set to true, the maximum allowed page size # is 1000. Otherwise, the maximum allowed page size is 100. # Default is 100 if empty or a number < 1 is specified. # @param [String] page_token - # Optional. The starting point of a query result. + # Optional. + # The starting point of a query result. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -365,7 +373,8 @@ module Google # Typically, the job becomes unsearchable within 10 seconds, but it may take # up to 5 minutes. # @param [String] name - # Required. The resource name of the job to be deleted, such as "jobs/11111111". + # Required. + # The resource name of the job to be deleted, such as "jobs/11111111". # @param [Boolean] disable_fast_process # Deprecated. This field is not working anymore. # Optional. @@ -436,7 +445,8 @@ module Google # Retrieves the specified job, whose status is OPEN or recently EXPIRED # within the last 90 days. # @param [String] name - # Required. The resource name of the job to retrieve, such as "jobs/11111111". + # Required. + # The resource name of the job to retrieve, such as "jobs/11111111". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -506,7 +516,8 @@ module Google # Lists jobs by filter. # @param [String] filter - # Required. The filter string specifies the jobs to be enumerated. + # Required. + # The filter string specifies the jobs to be enumerated. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -515,17 +526,20 @@ module Google # * companyName = "companies/123" # * companyName = "companies/123" AND requisitionId = "req-1" # @param [Boolean] ids_only - # Optional. If set to `true`, only Job.name, Job.requisition_id and + # Optional. + # If set to `true`, only Job.name, Job.requisition_id and # Job.language_code will be returned. # A typical use case is to synchronize job repositories. # Defaults to false. # @param [Fixnum] page_size - # Optional. The maximum number of jobs to be returned per page of results. + # Optional. + # The maximum number of jobs to be returned per page of results. # If ids_only is set to true, the maximum allowed page size # is 1000. Otherwise, the maximum allowed page size is 100. # Default is 100 if empty or a number < 1 is specified. # @param [String] page_token - # Optional. The starting point of a query result. + # Optional. + # The starting point of a query result. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -667,9 +681,11 @@ module Google # Completes the specified prefix with job keyword suggestions. # Intended for use by a job search auto-complete search box. # @param [String] company_name - # Optional. If provided, restricts completion to the specified company. + # Optional. + # If provided, restricts completion to the specified company. # @param [String] language_code - # Required. The language of the query. This is + # Required. + # The language of the query. This is # the BCP-47 language code, such as "en-US" or "sr-Latn". # For more information, see # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). @@ -682,14 +698,18 @@ module Google # language_code or companies having open jobs with same # language_code are returned. # @param [Fixnum] page_size - # Required. Completion result count. + # Required. + # Completion result count. # The maximum allowed page size is 10. # @param [String] query - # Required. The query used to generate suggestions. + # Required. + # The query used to generate suggestions. # @param [String] scope - # Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. + # Optional. + # The scope of the completion. The defaults is CompletionScope.PUBLIC. # @param [String] type - # Optional. The completion topic. The default is CompletionType.COMBINED. + # Optional. + # The completion topic. The default is CompletionType.COMBINED. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/jobs_v3.rb b/generated/google/apis/jobs_v3.rb index eef2ebe4e..ffbb289ff 100644 --- a/generated/google/apis/jobs_v3.rb +++ b/generated/google/apis/jobs_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3 VERSION = 'V3' - REVISION = '20190629' + REVISION = '20190712' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v3/classes.rb b/generated/google/apis/jobs_v3/classes.rb index f80ebee0a..4a54a73f4 100644 --- a/generated/google/apis/jobs_v3/classes.rb +++ b/generated/google/apis/jobs_v3/classes.rb @@ -75,8 +75,7 @@ module Google class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. - # The filter string specifies the jobs to be deleted. + # Required. The filter string specifies the jobs to be deleted. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -155,22 +154,21 @@ module Google class ClientEvent include Google::Apis::Core::Hashable - # Required. - # The timestamp of the event. + # 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` + # 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). # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id - # Optional. - # Extra information about this event. Used for storing information with no + # 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 @@ -185,8 +183,8 @@ module Google # @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 + # 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 @@ -197,8 +195,7 @@ module Google # @return [String] attr_accessor :parent_event_id - # Required. - # A unique ID generated in the API responses. It can be found in + # Required. A unique ID generated in the API responses. It can be found in # ResponseMetadata.request_id. # Corresponds to the JSON property `requestId` # @return [String] @@ -224,8 +221,8 @@ module Google class CommuteFilter include Google::Apis::Core::Hashable - # Optional. - # If true, jobs without "precise" addresses (street level addresses or GPS + # 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 @@ -239,8 +236,7 @@ module Google 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. + # Required. The method of transportation for which to calculate the commute time. # Corresponds to the JSON property `commuteMethod` # @return [String] attr_accessor :commute_method @@ -252,8 +248,7 @@ module Google # @return [Google::Apis::JobsV3::TimeOfDay] attr_accessor :departure_time - # Optional. - # Specifies the traffic density to use when calculating commute time. + # Optional. Specifies the traffic density to use when calculating commute time. # Corresponds to the JSON property `roadTraffic` # @return [String] attr_accessor :road_traffic @@ -267,8 +262,8 @@ module Google # @return [Google::Apis::JobsV3::LatLng] attr_accessor :start_coordinates - # Required. - # The maximum travel time in seconds. The maximum allowed value is `3600s` + # Required. The maximum travel time in seconds. The maximum allowed value is ` + # 3600s` # (one hour). Format is `123s`. # Corresponds to the JSON property `travelDuration` # @return [String] @@ -325,8 +320,8 @@ module Google class Company include Google::Apis::Core::Hashable - # Optional. - # The URI to employer's career site or careers page on the employer's web + # Optional. The URI to employer's career site or careers page on the employer's + # web # site, for example, "https://careers.google.com". # Corresponds to the JSON property `careerSiteUri` # @return [String] @@ -337,14 +332,12 @@ module Google # @return [Google::Apis::JobsV3::CompanyDerivedInfo] attr_accessor :derived_info - # Required. - # The display name of the company, for example, "Google, LLC". + # 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 + # 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. @@ -352,16 +345,14 @@ module Google # @return [String] attr_accessor :eeo_text - # Required. - # Client side company identifier, used to uniquely identify the + # Required. Client side company identifier, used to uniquely identify the # company. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id - # Optional. - # The street address of the company's main headquarters, which may be + # 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. @@ -369,8 +360,7 @@ module Google # @return [String] attr_accessor :headquarters_address - # Optional. - # Set to true if it is the hiring agency that post jobs for other + # Optional. Set to true if it is the hiring agency that post jobs for other # employers. # Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` @@ -378,14 +368,12 @@ module Google attr_accessor :hiring_agency alias_method :hiring_agency?, :hiring_agency - # Optional. - # A URI that hosts the employer's company logo. + # Optional. A URI that hosts the employer's company logo. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri - # Optional. - # A list of keys of filterable Job.custom_attributes, whose + # 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 @@ -404,8 +392,7 @@ module Google # @return [String] attr_accessor :name - # Optional. - # The employer's company size. + # Optional. The employer's company size. # Corresponds to the JSON property `size` # @return [String] attr_accessor :size @@ -418,8 +405,7 @@ module Google attr_accessor :suspended alias_method :suspended?, :suspended - # Optional. - # The URI representing the company's primary web site or home page, + # Optional. The URI representing the company's primary web site or home page, # for example, "https://www.google.com". # The maximum number of allowed characters is 255. # Corresponds to the JSON property `websiteUri` @@ -483,16 +469,14 @@ module Google # @return [Google::Apis::JobsV3::Money] attr_accessor :amount - # Optional. - # Compensation description. For example, could + # 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 + # 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 @@ -509,15 +493,13 @@ module Google # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :range - # Optional. - # Compensation type. + # 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. + # Optional. Frequency of the specified amount. # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] @@ -543,8 +525,7 @@ module Google class CompensationFilter include Google::Apis::Core::Hashable - # Optional. - # If set to true, jobs with unspecified compensation range fields are + # Optional. If set to true, jobs with unspecified compensation range fields are # included. # Corresponds to the JSON property `includeJobsWithUnspecifiedCompensationRange` # @return [Boolean] @@ -556,14 +537,12 @@ module Google # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :range - # Required. - # Type of filter. + # Required. Type of filter. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Required. - # Specify desired `base compensation entry's` + # Required. Specify desired `base compensation entry's` # CompensationInfo.CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] @@ -593,8 +572,8 @@ module Google # @return [Google::Apis::JobsV3::NumericBucketingOption] attr_accessor :bucketing_option - # Required. - # Type of the request, representing which field the histogramming should be + # 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`. # Corresponds to the JSON property `type` @@ -654,8 +633,7 @@ module Google # @return [Google::Apis::JobsV3::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. - # Job compensation information. + # 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. @@ -830,8 +808,7 @@ module Google class CustomAttribute include Google::Apis::Core::Hashable - # Optional. - # If the `filterable` flag is true, custom field values are searchable. + # Optional. If the `filterable` flag is true, custom field values are searchable. # If false, values are not searchable. # Default is false. # Corresponds to the JSON property `filterable` @@ -879,8 +856,8 @@ module Google class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable - # Required. - # Specifies the custom field key to perform a histogram on. If specified + # 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. @@ -953,14 +930,12 @@ module Google class DeviceInfo include Google::Apis::Core::Hashable - # Optional. - # Type of the device. + # Optional. Type of the device. # Corresponds to the JSON property `deviceType` # @return [String] attr_accessor :device_type - # Optional. - # A device-specific ID. The ID must be a unique identifier that + # Optional. A device-specific ID. The ID must be a unique identifier that # distinguishes the device from other devices. # Corresponds to the JSON property `id` # @return [String] @@ -1001,23 +976,20 @@ module Google class HistogramFacets include Google::Apis::Core::Hashable - # Optional. - # Specifies compensation field-based histogram requests. + # Optional. Specifies compensation field-based histogram requests. # Duplicate values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. - # Specifies the custom attributes histogram requests. + # Optional. Specifies the custom attributes histogram requests. # Duplicate values of CustomAttributeHistogramRequest.key are not # allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array] attr_accessor :custom_attribute_histogram_facets - # Optional. - # Specifies the simple type of histogram facets, for example, + # Optional. Specifies the simple type of histogram facets, for example, # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array] @@ -1136,8 +1108,7 @@ module Google # @return [String] attr_accessor :company_display_name - # Required. - # The resource name of the company listing the job, such as + # 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] @@ -1148,8 +1119,8 @@ module Google # @return [Google::Apis::JobsV3::CompensationInfo] attr_accessor :compensation_info - # Optional. - # A map of fields to hold both filterable and non-filterable custom job + # 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 @@ -1163,14 +1134,13 @@ module Google # @return [Hash] attr_accessor :custom_attributes - # Optional. - # The desired education degrees for the job, such as Bachelors, Masters. + # Optional. The desired education degrees for the job, such as Bachelors, + # Masters. # Corresponds to the JSON property `degreeTypes` # @return [Array] attr_accessor :degree_types - # Optional. - # The department or functional area within the company with the open + # Optional. The department or functional area within the company with the open # position. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` @@ -1183,8 +1153,8 @@ module Google # @return [Google::Apis::JobsV3::JobDerivedInfo] attr_accessor :derived_info - # Required. - # The description of the job, which typically includes a multi-paragraph + # 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 @@ -1196,50 +1166,45 @@ module Google # @return [String] attr_accessor :description - # Optional. - # The employment type(s) of a job, for example, + # Optional. The employment type(s) of a job, for example, # full time or # part time. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types - # Optional. - # A description of bonus, commission, and other compensation + # 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. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives - # Optional. - # The benefits included with the job. + # Optional. The benefits included with the job. # Corresponds to the JSON property `jobBenefits` # @return [Array] attr_accessor :job_benefits - # Optional. - # The end timestamp of the job. Typically this field is used for contracting + # Optional. The end timestamp of the job. Typically this field is used for + # 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". + # 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 + # Optional. The start timestamp of the job in UTC time zone. Typically this + # 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 + # 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 @@ -1299,16 +1264,15 @@ module Google # @return [String] attr_accessor :posting_expire_time - # Optional. - # The timestamp this job posting was most recently published. The default + # 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. # Corresponds to the JSON property `postingPublishTime` # @return [String] attr_accessor :posting_publish_time - # Optional. - # The job PostingRegion (for example, state, country) throughout which + # 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. @@ -1330,8 +1294,7 @@ module Google # @return [Google::Apis::JobsV3::ProcessingOptions] attr_accessor :processing_options - # Optional. - # A promotion value of the job, as determined by the client. + # 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 @@ -1341,8 +1304,7 @@ module Google # @return [Fixnum] attr_accessor :promotion_value - # Optional. - # A description of the qualifications required to perform the + # 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 @@ -1352,8 +1314,8 @@ module Google # @return [String] attr_accessor :qualifications - # Required. - # The requisition ID, also referred to as the posting ID, assigned by the + # 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], @@ -1363,8 +1325,7 @@ module Google # @return [String] attr_accessor :requisition_id - # Optional. - # A description of job responsibilities. The use of this field is + # 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 @@ -1374,15 +1335,13 @@ module Google # @return [String] attr_accessor :responsibilities - # Required. - # The title of the job, such as "Software Engineer" + # 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 - # Optional. - # The visibility of the job. + # Optional. The visibility of the job. # Defaults to Visibility.ACCOUNT_ONLY if not specified. # Corresponds to the JSON property `visibility` # @return [String] @@ -1460,8 +1419,7 @@ module Google class JobEvent include Google::Apis::Core::Hashable - # Required. - # The job name(s) associated with this event. + # 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 @@ -1470,8 +1428,7 @@ module Google # @return [Array] attr_accessor :jobs - # Required. - # The type of the event (see JobEventType). + # Required. The type of the event (see JobEventType). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1498,8 +1455,7 @@ module Google # @return [Google::Apis::JobsV3::CommuteFilter] attr_accessor :commute_filter - # Optional. - # This filter specifies the exact company display + # 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. @@ -1510,8 +1466,7 @@ module Google # @return [Array] attr_accessor :company_display_names - # Optional. - # This filter specifies the company entities to search against. + # 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 @@ -1529,8 +1484,7 @@ module Google # @return [Google::Apis::JobsV3::CompensationFilter] attr_accessor :compensation_filter - # Optional. - # This filter specifies a structured syntax to match against the + # 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 @@ -1543,7 +1497,7 @@ module Google # 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 < 3000 bytes in length. + # must be < 6000 bytes in length. # Sample Query: # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND # driving_years > 10` @@ -1551,8 +1505,7 @@ module Google # @return [String] attr_accessor :custom_attribute_filter - # Optional. - # This flag controls the spell-check feature. If false, the + # 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. @@ -1561,8 +1514,7 @@ module Google 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 + # 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. @@ -1572,8 +1524,8 @@ module Google # @return [Array] attr_accessor :employment_types - # Optional. - # The category filter specifies the categories of jobs to search against. + # 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 @@ -1582,8 +1534,7 @@ module Google # @return [Array] attr_accessor :job_categories - # Optional. - # This filter specifies the locale of jobs to search against, + # 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. @@ -1595,8 +1546,7 @@ module Google # @return [Array] attr_accessor :language_codes - # Optional. - # The location filter specifies geo-regions containing the jobs to + # 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. @@ -1614,8 +1564,8 @@ module Google # @return [Google::Apis::JobsV3::TimestampRange] attr_accessor :publish_time_range - # Optional. - # The query string that matches against the job title, description, and + # Optional. The query string that matches against the job title, description, + # and # location fields. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `query` @@ -1771,7 +1721,7 @@ module Google # existing data, depending on the type of process. # Advice on address input / editing: # - Use an i18n-ready address widget such as - # https://github.com/googlei18n/libaddressinput) + # 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: @@ -1807,14 +1757,13 @@ module Google class LocationFilter include Google::Apis::Core::Hashable - # Optional. - # The address name, such as "Mountain View" or "Bay Area". + # 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 + # 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. # Corresponds to the JSON property `distanceInMiles` @@ -1830,8 +1779,7 @@ module Google # @return [Google::Apis::JobsV3::LatLng] attr_accessor :lat_lng - # Optional. - # CLDR region code of the country/region of the address. This is used + # 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, @@ -1843,8 +1791,7 @@ module Google # @return [String] attr_accessor :region_code - # Optional. - # Allows the client to return jobs without a + # 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. @@ -1972,8 +1919,7 @@ module Google class NumericBucketingOption include Google::Apis::Core::Hashable - # Required. - # Two adjacent values form a histogram bucket. Values should be in + # 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. @@ -1981,8 +1927,7 @@ module Google # @return [Array] attr_accessor :bucket_bounds - # Optional. - # If set to true, the histogram result includes minimum/maximum + # Optional. If set to true, the histogram result includes minimum/maximum # value of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] @@ -2044,7 +1989,7 @@ module Google # existing data, depending on the type of process. # Advice on address input / editing: # - Use an i18n-ready address widget such as - # https://github.com/googlei18n/libaddressinput) + # 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: @@ -2184,16 +2129,14 @@ module Google class ProcessingOptions include Google::Apis::Core::Hashable - # Optional. - # If set to `true`, the service does not attempt to resolve a + # 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: + # Optional. Option for job HTML content sanitization. Applied fields are: # * description # * applicationInfo.instruction # * incentives @@ -2231,8 +2174,8 @@ module Google # @return [Google::Apis::JobsV3::DeviceInfo] attr_accessor :device_info - # Required. - # The client-defined scope or source of the service call, which typically + # 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 Foo, Inc., on @@ -2247,8 +2190,7 @@ module Google # @return [String] attr_accessor :domain - # Required. - # A unique session identification string. A session is defined as the + # 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 @@ -2261,8 +2203,7 @@ module Google # @return [String] attr_accessor :session_id - # Required. - # A unique user identification string, as determined by the client. + # 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 @@ -2314,8 +2255,7 @@ module Google class SearchJobsRequest include Google::Apis::Core::Hashable - # Optional. - # Controls whether to disable exact keyword match on Job.job_title, + # 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 @@ -2336,8 +2276,8 @@ module Google 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 + # 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 @@ -2349,8 +2289,8 @@ module Google # @return [String] attr_accessor :diversification_level - # Optional. - # Controls whether to broaden the search when it produces sparse results. + # 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. @@ -2371,15 +2311,14 @@ module Google # @return [Google::Apis::JobsV3::JobQuery] attr_accessor :job_query - # Optional. - # The desired job attributes returned for jobs in the + # 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 + # 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. # For example, 0 means to return results starting from the first matching @@ -2390,8 +2329,7 @@ module Google # @return [Fixnum] attr_accessor :offset - # Optional. - # The criteria determining how search results are sorted. Default is + # 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 @@ -2423,16 +2361,14 @@ module Google # @return [String] attr_accessor :order_by - # Optional. - # A limit on the number of jobs returned in the search results. + # Optional. A limit on the number of jobs returned in the search results. # Increasing this value above the default value of 10 can increase search # 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 + # 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` @@ -2447,8 +2383,7 @@ module Google # @return [Google::Apis::JobsV3::RequestMetadata] attr_accessor :request_metadata - # Optional. - # Controls if the search job request requires the return of a precise + # 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 @@ -2460,8 +2395,7 @@ module Google attr_accessor :require_precise_result_size alias_method :require_precise_result_size?, :require_precise_result_size - # Optional. - # Mode of a search. + # Optional. Mode of a search. # Defaults to SearchMode.JOB_SEARCH. # Corresponds to the JSON property `searchMode` # @return [String] diff --git a/generated/google/apis/jobs_v3/service.rb b/generated/google/apis/jobs_v3/service.rb index a5ef79d12..c995d319b 100644 --- a/generated/google/apis/jobs_v3/service.rb +++ b/generated/google/apis/jobs_v3/service.rb @@ -51,13 +51,11 @@ module Google # Completes the specified prefix with keyword suggestions. # Intended for use by a job search auto-complete search box. # @param [String] name - # Required. - # Resource name of project the completion is performed within. + # Required. Resource name of project the completion is performed within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [String] company_name - # Optional. - # If provided, restricts completion to specified company. + # Optional. If provided, restricts completion to specified company. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] language_code @@ -77,8 +75,7 @@ module Google # language_code are returned. # The maximum number of allowed characters is 255. # @param [Array, String] language_codes - # Optional. - # The list of languages of the query. This is + # Optional. The list of languages of the query. This is # the BCP-47 language code, such as "en-US" or "sr-Latn". # For more information, see # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). @@ -92,19 +89,15 @@ module Google # language_codes are returned. # The maximum number of allowed characters is 255. # @param [Fixnum] page_size - # Required. - # Completion result count. + # Required. Completion result count. # The maximum allowed page size is 10. # @param [String] query - # Required. - # The query used to generate suggestions. + # Required. The query used to generate suggestions. # The maximum number of allowed characters is 255. # @param [String] scope - # Optional. - # The scope of the completion. The defaults is CompletionScope.PUBLIC. + # Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. # @param [String] type - # Optional. - # The completion topic. The default is CompletionType.COMBINED. + # Optional. The completion topic. The default is CompletionType.COMBINED. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -180,8 +173,7 @@ module Google # Creates a new company entity. # @param [String] parent - # Required. - # Resource name of the project under which the company is created. + # Required. Resource name of the project under which the company is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3::CreateCompanyRequest] create_company_request_object @@ -217,8 +209,7 @@ module Google # Deletes specified company. # Prerequisite: The company has no jobs associated with it. # @param [String] name - # Required. - # The resource name of the company to be deleted. + # Required. The resource name of the company to be deleted. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] fields @@ -250,8 +241,7 @@ module Google # Retrieves specified company. # @param [String] name - # Required. - # The resource name of the company to be retrieved. + # Required. The resource name of the company to be retrieved. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] fields @@ -283,20 +273,16 @@ module Google # Lists all companies associated with the service account. # @param [String] parent - # Required. - # Resource name of the project under which the company is created. + # Required. Resource name of the project under which the company is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Fixnum] page_size - # Optional. - # The maximum number of companies to be returned, at most 100. + # Optional. The maximum number of companies to be returned, at most 100. # Default is 100 if a non-positive number is provided. # @param [String] page_token - # Optional. - # The starting indicator from which to return results. + # Optional. The starting indicator from which to return results. # @param [Boolean] require_open_jobs - # Optional. - # Set to true if the companies requested must have open jobs. + # Optional. Set to true if the companies requested must have open jobs. # Defaults to false. # If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. @@ -371,8 +357,7 @@ module Google # Deletes a list of Jobs by filter. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3::BatchDeleteJobsRequest] batch_delete_jobs_request_object @@ -409,8 +394,7 @@ module Google # Typically, the job becomes searchable within 10 seconds, but it may take # up to 5 minutes. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3::CreateJobRequest] create_job_request_object @@ -447,8 +431,7 @@ module Google # Typically, the job becomes unsearchable within 10 seconds, but it may take # up to 5 minutes. # @param [String] name - # Required. - # The resource name of the job to be deleted. + # Required. The resource name of the job to be deleted. # The format is "projects/`project_id`/jobs/`job_id`", # for example, "projects/api-test-project/jobs/1234". # @param [String] fields @@ -481,8 +464,7 @@ module Google # Retrieves the specified job, whose status is OPEN or recently EXPIRED # within the last 90 days. # @param [String] name - # Required. - # The resource name of the job to retrieve. + # Required. The resource name of the job to retrieve. # The format is "projects/`project_id`/jobs/`job_id`", # for example, "projects/api-test-project/jobs/1234". # @param [String] fields @@ -514,13 +496,11 @@ module Google # Lists jobs by filter. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [String] filter - # Required. - # The filter string specifies the jobs to be enumerated. + # Required. The filter string specifies the jobs to be enumerated. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -530,19 +510,16 @@ module Google # * companyName = "projects/api-test-project/companies/123" AND requisitionId # = "req-1" # @param [String] job_view - # Optional. - # The desired job attributes returned for jobs in the + # Optional. The desired job attributes returned for jobs in the # search response. Defaults to JobView.JOB_VIEW_FULL if no value is # specified. # @param [Fixnum] page_size - # Optional. - # The maximum number of jobs to be returned per page of results. + # Optional. The maximum number of jobs to be returned per page of results. # If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed # page size is 1000. Otherwise, the maximum allowed page size is 100. # Default is 100 if empty or a number < 1 is specified. # @param [String] page_token - # Optional. - # The starting point of a query result. + # Optional. The starting point of a query result. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -620,8 +597,7 @@ module Google # present in the database, and only returns jobs that the caller has # permission to search against. # @param [String] parent - # Required. - # The resource name of the project to search within. + # Required. The resource name of the project to search within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3::SearchJobsRequest] search_jobs_request_object @@ -663,8 +639,7 @@ module Google # present in the database, and only returns jobs the caller has # permission to search against. # @param [String] parent - # Required. - # The resource name of the project to search within. + # Required. The resource name of the project to search within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3::SearchJobsRequest] search_jobs_request_object diff --git a/generated/google/apis/jobs_v3p1beta1.rb b/generated/google/apis/jobs_v3p1beta1.rb index 7ca184273..91b1e5a7d 100644 --- a/generated/google/apis/jobs_v3p1beta1.rb +++ b/generated/google/apis/jobs_v3p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/talent-solution/job-search/docs/ module JobsV3p1beta1 VERSION = 'V3p1beta1' - REVISION = '20190629' + REVISION = '20190712' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/jobs_v3p1beta1/classes.rb b/generated/google/apis/jobs_v3p1beta1/classes.rb index 9c25dfa86..18060ab0a 100644 --- a/generated/google/apis/jobs_v3p1beta1/classes.rb +++ b/generated/google/apis/jobs_v3p1beta1/classes.rb @@ -75,8 +75,7 @@ module Google class BatchDeleteJobsRequest include Google::Apis::Core::Hashable - # Required. - # The filter string specifies the jobs to be deleted. + # Required. The filter string specifies the jobs to be deleted. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -155,22 +154,21 @@ module Google class ClientEvent include Google::Apis::Core::Hashable - # Required. - # The timestamp of the event. + # 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` + # 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). # Corresponds to the JSON property `eventId` # @return [String] attr_accessor :event_id - # Optional. - # Extra information about this event. Used for storing information with no + # 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 @@ -185,8 +183,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::JobEvent] attr_accessor :job_event - # Optional. - # The event_id of an event that resulted in the current event. For example, a + # 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 @@ -197,8 +195,7 @@ module Google # @return [String] attr_accessor :parent_event_id - # Required. - # A unique ID generated in the API responses. It can be found in + # Required. A unique ID generated in the API responses. It can be found in # ResponseMetadata.request_id. # Corresponds to the JSON property `requestId` # @return [String] @@ -224,8 +221,8 @@ module Google class CommuteFilter include Google::Apis::Core::Hashable - # Optional. - # If true, jobs without "precise" addresses (street level addresses or GPS + # 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 @@ -239,8 +236,7 @@ module Google 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. + # Required. The method of transportation for which to calculate the commute time. # Corresponds to the JSON property `commuteMethod` # @return [String] attr_accessor :commute_method @@ -252,8 +248,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::TimeOfDay] attr_accessor :departure_time - # Optional. - # Specifies the traffic density to use when calculating commute time. + # Optional. Specifies the traffic density to use when calculating commute time. # Corresponds to the JSON property `roadTraffic` # @return [String] attr_accessor :road_traffic @@ -267,8 +262,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::LatLng] attr_accessor :start_coordinates - # Required. - # The maximum travel time in seconds. The maximum allowed value is `3600s` + # Required. The maximum travel time in seconds. The maximum allowed value is ` + # 3600s` # (one hour). Format is `123s`. # Corresponds to the JSON property `travelDuration` # @return [String] @@ -325,8 +320,8 @@ module Google class Company include Google::Apis::Core::Hashable - # Optional. - # The URI to employer's career site or careers page on the employer's web + # Optional. The URI to employer's career site or careers page on the employer's + # web # site, for example, "https://careers.google.com". # Corresponds to the JSON property `careerSiteUri` # @return [String] @@ -337,14 +332,12 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompanyDerivedInfo] attr_accessor :derived_info - # Required. - # The display name of the company, for example, "Google, LLC". + # 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 + # 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. @@ -352,16 +345,14 @@ module Google # @return [String] attr_accessor :eeo_text - # Required. - # Client side company identifier, used to uniquely identify the + # Required. Client side company identifier, used to uniquely identify the # company. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `externalId` # @return [String] attr_accessor :external_id - # Optional. - # The street address of the company's main headquarters, which may be + # 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. @@ -369,8 +360,7 @@ module Google # @return [String] attr_accessor :headquarters_address - # Optional. - # Set to true if it is the hiring agency that post jobs for other + # Optional. Set to true if it is the hiring agency that post jobs for other # employers. # Defaults to false if not provided. # Corresponds to the JSON property `hiringAgency` @@ -378,14 +368,12 @@ module Google attr_accessor :hiring_agency alias_method :hiring_agency?, :hiring_agency - # Optional. - # A URI that hosts the employer's company logo. + # Optional. A URI that hosts the employer's company logo. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri - # Optional. - # A list of keys of filterable Job.custom_attributes, whose + # 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 @@ -404,8 +392,7 @@ module Google # @return [String] attr_accessor :name - # Optional. - # The employer's company size. + # Optional. The employer's company size. # Corresponds to the JSON property `size` # @return [String] attr_accessor :size @@ -418,8 +405,7 @@ module Google attr_accessor :suspended alias_method :suspended?, :suspended - # Optional. - # The URI representing the company's primary web site or home page, + # Optional. The URI representing the company's primary web site or home page, # for example, "https://www.google.com". # The maximum number of allowed characters is 255. # Corresponds to the JSON property `websiteUri` @@ -483,16 +469,14 @@ module Google # @return [Google::Apis::JobsV3p1beta1::Money] attr_accessor :amount - # Optional. - # Compensation description. For example, could + # 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 + # 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 @@ -509,15 +493,13 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationRange] attr_accessor :range - # Optional. - # Compensation type. + # 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. + # Optional. Frequency of the specified amount. # Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. # Corresponds to the JSON property `unit` # @return [String] @@ -543,8 +525,7 @@ module Google class CompensationFilter include Google::Apis::Core::Hashable - # Optional. - # If set to true, jobs with unspecified compensation range fields are + # Optional. If set to true, jobs with unspecified compensation range fields are # included. # Corresponds to the JSON property `includeJobsWithUnspecifiedCompensationRange` # @return [Boolean] @@ -556,14 +537,12 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationRange] attr_accessor :range - # Required. - # Type of filter. + # Required. Type of filter. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # Required. - # Specify desired `base compensation entry's` + # Required. Specify desired `base compensation entry's` # CompensationInfo.CompensationUnit. # Corresponds to the JSON property `units` # @return [Array] @@ -593,8 +572,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::NumericBucketingOption] attr_accessor :bucketing_option - # Required. - # Type of the request, representing which field the histogramming should be + # 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`. # Corresponds to the JSON property `type` @@ -654,8 +633,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationRange] attr_accessor :annualized_total_compensation_range - # Optional. - # Job compensation information. + # 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. @@ -830,8 +808,7 @@ module Google class CustomAttribute include Google::Apis::Core::Hashable - # Optional. - # If the `filterable` flag is true, custom field values are searchable. + # Optional. If the `filterable` flag is true, custom field values are searchable. # If false, values are not searchable. # Default is false. # Corresponds to the JSON property `filterable` @@ -879,8 +856,8 @@ module Google class CustomAttributeHistogramRequest include Google::Apis::Core::Hashable - # Required. - # Specifies the custom field key to perform a histogram on. If specified + # 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. @@ -952,8 +929,7 @@ module Google class CustomRankingInfo include Google::Apis::Core::Hashable - # Required. - # Controls over how important the score of + # Required. Controls over how important the score of # CustomRankingInfo.ranking_expression gets applied to job's final # ranking position. # An error is thrown if not specified. @@ -961,8 +937,8 @@ module Google # @return [String] attr_accessor :importance_level - # Required. - # Controls over how job documents get ranked on top of existing relevance + # Required. Controls over how job documents get ranked on top of existing + # relevance # score (determined by API algorithm). The product of ranking expression # and relevance score is used to determine job's final ranking position. # The syntax for this expression is a subset of Google SQL syntax. @@ -994,14 +970,12 @@ module Google class DeviceInfo include Google::Apis::Core::Hashable - # Optional. - # Type of the device. + # Optional. Type of the device. # Corresponds to the JSON property `deviceType` # @return [String] attr_accessor :device_type - # Optional. - # A device-specific ID. The ID must be a unique identifier that + # Optional. A device-specific ID. The ID must be a unique identifier that # distinguishes the device from other devices. # Corresponds to the JSON property `id` # @return [String] @@ -1042,23 +1016,20 @@ module Google class HistogramFacets include Google::Apis::Core::Hashable - # Optional. - # Specifies compensation field-based histogram requests. + # Optional. Specifies compensation field-based histogram requests. # Duplicate values of CompensationHistogramRequest.type are not allowed. # Corresponds to the JSON property `compensationHistogramFacets` # @return [Array] attr_accessor :compensation_histogram_facets - # Optional. - # Specifies the custom attributes histogram requests. + # Optional. Specifies the custom attributes histogram requests. # Duplicate values of CustomAttributeHistogramRequest.key are not # allowed. # Corresponds to the JSON property `customAttributeHistogramFacets` # @return [Array] attr_accessor :custom_attribute_histogram_facets - # Optional. - # Specifies the simple type of histogram facets, for example, + # Optional. Specifies the simple type of histogram facets, for example, # `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. # Corresponds to the JSON property `simpleHistogramFacets` # @return [Array] @@ -1307,8 +1278,7 @@ module Google # @return [String] attr_accessor :company_display_name - # Required. - # The resource name of the company listing the job, such as + # 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] @@ -1319,8 +1289,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationInfo] attr_accessor :compensation_info - # Optional. - # A map of fields to hold both filterable and non-filterable custom job + # 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 @@ -1334,14 +1304,13 @@ module Google # @return [Hash] attr_accessor :custom_attributes - # Optional. - # The desired education degrees for the job, such as Bachelors, Masters. + # Optional. The desired education degrees for the job, such as Bachelors, + # Masters. # Corresponds to the JSON property `degreeTypes` # @return [Array] attr_accessor :degree_types - # Optional. - # The department or functional area within the company with the open + # Optional. The department or functional area within the company with the open # position. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `department` @@ -1354,8 +1323,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::JobDerivedInfo] attr_accessor :derived_info - # Required. - # The description of the job, which typically includes a multi-paragraph + # 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 @@ -1367,50 +1336,45 @@ module Google # @return [String] attr_accessor :description - # Optional. - # The employment type(s) of a job, for example, + # Optional. The employment type(s) of a job, for example, # full time or # part time. # Corresponds to the JSON property `employmentTypes` # @return [Array] attr_accessor :employment_types - # Optional. - # A description of bonus, commission, and other compensation + # 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. # Corresponds to the JSON property `incentives` # @return [String] attr_accessor :incentives - # Optional. - # The benefits included with the job. + # Optional. The benefits included with the job. # Corresponds to the JSON property `jobBenefits` # @return [Array] attr_accessor :job_benefits - # Optional. - # The end timestamp of the job. Typically this field is used for contracting + # Optional. The end timestamp of the job. Typically this field is used for + # 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". + # 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 + # Optional. The start timestamp of the job in UTC time zone. Typically this + # 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 + # 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 @@ -1470,16 +1434,15 @@ module Google # @return [String] attr_accessor :posting_expire_time - # Optional. - # The timestamp this job posting was most recently published. The default + # 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. # Corresponds to the JSON property `postingPublishTime` # @return [String] attr_accessor :posting_publish_time - # Optional. - # The job PostingRegion (for example, state, country) throughout which + # 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. @@ -1501,8 +1464,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::ProcessingOptions] attr_accessor :processing_options - # Optional. - # A promotion value of the job, as determined by the client. + # 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 @@ -1512,8 +1474,7 @@ module Google # @return [Fixnum] attr_accessor :promotion_value - # Optional. - # A description of the qualifications required to perform the + # 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 @@ -1523,8 +1484,8 @@ module Google # @return [String] attr_accessor :qualifications - # Required. - # The requisition ID, also referred to as the posting ID, assigned by the + # 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], @@ -1534,8 +1495,7 @@ module Google # @return [String] attr_accessor :requisition_id - # Optional. - # A description of job responsibilities. The use of this field is + # 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 @@ -1545,15 +1505,13 @@ module Google # @return [String] attr_accessor :responsibilities - # Required. - # The title of the job, such as "Software Engineer" + # 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 - # Optional. - # The visibility of the job. + # Optional. The visibility of the job. # Defaults to Visibility.ACCOUNT_ONLY if not specified. # Corresponds to the JSON property `visibility` # @return [String] @@ -1631,8 +1589,7 @@ module Google class JobEvent include Google::Apis::Core::Hashable - # Required. - # The job name(s) associated with this event. + # 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 @@ -1641,8 +1598,7 @@ module Google # @return [Array] attr_accessor :jobs - # Required. - # The type of the event (see JobEventType). + # Required. The type of the event (see JobEventType). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1669,8 +1625,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CommuteFilter] attr_accessor :commute_filter - # Optional. - # This filter specifies the exact company display + # 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. @@ -1681,8 +1636,7 @@ module Google # @return [Array] attr_accessor :company_display_names - # Optional. - # This filter specifies the company entities to search against. + # 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 @@ -1700,8 +1654,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CompensationFilter] attr_accessor :compensation_filter - # Optional. - # This filter specifies a structured syntax to match against the + # 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 @@ -1714,7 +1667,7 @@ module Google # 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 < 3000 bytes in length. + # must be < 6000 bytes in length. # Sample Query: # `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND # driving_years > 10` @@ -1722,8 +1675,7 @@ module Google # @return [String] attr_accessor :custom_attribute_filter - # Optional. - # This flag controls the spell-check feature. If false, the + # 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. @@ -1732,8 +1684,7 @@ module Google 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 + # 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. @@ -1743,15 +1694,15 @@ module Google # @return [Array] attr_accessor :employment_types - # Optional. - # This filter specifies a list of job names to be excluded during search. + # Optional. This filter specifies a list of job names to be excluded during + # search. # At most 400 excluded job names are allowed. # Corresponds to the JSON property `excludedJobs` # @return [Array] attr_accessor :excluded_jobs - # Optional. - # The category filter specifies the categories of jobs to search against. + # 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 @@ -1760,8 +1711,7 @@ module Google # @return [Array] attr_accessor :job_categories - # Optional. - # This filter specifies the locale of jobs to search against, + # 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. @@ -1773,8 +1723,7 @@ module Google # @return [Array] attr_accessor :language_codes - # Optional. - # The location filter specifies geo-regions containing the jobs to + # 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. @@ -1792,8 +1741,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::TimestampRange] attr_accessor :publish_time_range - # Optional. - # The query string that matches against the job title, description, and + # Optional. The query string that matches against the job title, description, + # and # location fields. # The maximum number of allowed characters is 255. # Corresponds to the JSON property `query` @@ -1950,7 +1899,7 @@ module Google # existing data, depending on the type of process. # Advice on address input / editing: # - Use an i18n-ready address widget such as - # https://github.com/googlei18n/libaddressinput) + # 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: @@ -1986,14 +1935,13 @@ module Google class LocationFilter include Google::Apis::Core::Hashable - # Optional. - # The address name, such as "Mountain View" or "Bay Area". + # 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 + # 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. # Corresponds to the JSON property `distanceInMiles` @@ -2009,8 +1957,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::LatLng] attr_accessor :lat_lng - # Optional. - # CLDR region code of the country/region of the address. This is used + # 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, @@ -2022,8 +1969,7 @@ module Google # @return [String] attr_accessor :region_code - # Optional. - # Allows the client to return jobs without a + # 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. @@ -2151,8 +2097,7 @@ module Google class NumericBucketingOption include Google::Apis::Core::Hashable - # Required. - # Two adjacent values form a histogram bucket. Values should be in + # 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. @@ -2160,8 +2105,7 @@ module Google # @return [Array] attr_accessor :bucket_bounds - # Optional. - # If set to true, the histogram result includes minimum/maximum + # Optional. If set to true, the histogram result includes minimum/maximum # value of the numeric field. # Corresponds to the JSON property `requiresMinMax` # @return [Boolean] @@ -2287,7 +2231,7 @@ module Google # existing data, depending on the type of process. # Advice on address input / editing: # - Use an i18n-ready address widget such as - # https://github.com/googlei18n/libaddressinput) + # 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: @@ -2427,16 +2371,14 @@ module Google class ProcessingOptions include Google::Apis::Core::Hashable - # Optional. - # If set to `true`, the service does not attempt to resolve a + # 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: + # Optional. Option for job HTML content sanitization. Applied fields are: # * description # * applicationInfo.instruction # * incentives @@ -2474,8 +2416,8 @@ module Google # @return [Google::Apis::JobsV3p1beta1::DeviceInfo] attr_accessor :device_info - # Required. - # The client-defined scope or source of the service call, which typically + # 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 Foo, Inc., on @@ -2490,8 +2432,7 @@ module Google # @return [String] attr_accessor :domain - # Required. - # A unique session identification string. A session is defined as the + # 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 @@ -2504,8 +2445,7 @@ module Google # @return [String] attr_accessor :session_id - # Required. - # A unique user identification string, as determined by the client. + # 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 @@ -2563,8 +2503,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::CustomRankingInfo] attr_accessor :custom_ranking_info - # Optional. - # Controls whether to disable exact keyword match on Job.job_title, + # 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 @@ -2585,8 +2524,8 @@ module Google 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 + # 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 @@ -2598,8 +2537,8 @@ module Google # @return [String] attr_accessor :diversification_level - # Optional. - # Controls whether to broaden the search when it produces sparse results. + # 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. @@ -2614,8 +2553,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::HistogramFacets] attr_accessor :histogram_facets - # Optional. - # Expression based histogram requests for jobs matching JobQuery. + # Optional. Expression based histogram requests for jobs matching JobQuery. # Corresponds to the JSON property `histogramQueries` # @return [Array] attr_accessor :histogram_queries @@ -2626,15 +2564,14 @@ module Google # @return [Google::Apis::JobsV3p1beta1::JobQuery] attr_accessor :job_query - # Optional. - # The desired job attributes returned for jobs in the + # 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 + # 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. # For example, 0 means to return results starting from the first matching @@ -2645,8 +2582,7 @@ module Google # @return [Fixnum] attr_accessor :offset - # Optional. - # The criteria determining how search results are sorted. Default is + # 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 @@ -2698,16 +2634,14 @@ module Google # @return [String] attr_accessor :order_by - # Optional. - # A limit on the number of jobs returned in the search results. + # Optional. A limit on the number of jobs returned in the search results. # Increasing this value above the default value of 10 can increase search # 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 + # 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` @@ -2722,8 +2656,7 @@ module Google # @return [Google::Apis::JobsV3p1beta1::RequestMetadata] attr_accessor :request_metadata - # Optional. - # Controls if the search job request requires the return of a precise + # 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 @@ -2735,8 +2668,7 @@ module Google attr_accessor :require_precise_result_size alias_method :require_precise_result_size?, :require_precise_result_size - # Optional. - # Mode of a search. + # Optional. Mode of a search. # Defaults to SearchMode.JOB_SEARCH. # Corresponds to the JSON property `searchMode` # @return [String] diff --git a/generated/google/apis/jobs_v3p1beta1/service.rb b/generated/google/apis/jobs_v3p1beta1/service.rb index 770d371f8..b2700c773 100644 --- a/generated/google/apis/jobs_v3p1beta1/service.rb +++ b/generated/google/apis/jobs_v3p1beta1/service.rb @@ -51,13 +51,11 @@ module Google # Completes the specified prefix with keyword suggestions. # Intended for use by a job search auto-complete search box. # @param [String] name - # Required. - # Resource name of project the completion is performed within. + # Required. Resource name of project the completion is performed within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [String] company_name - # Optional. - # If provided, restricts completion to specified company. + # Optional. If provided, restricts completion to specified company. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] language_code @@ -77,8 +75,7 @@ module Google # language_code are returned. # The maximum number of allowed characters is 255. # @param [Array, String] language_codes - # Optional. - # The list of languages of the query. This is + # Optional. The list of languages of the query. This is # the BCP-47 language code, such as "en-US" or "sr-Latn". # For more information, see # [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). @@ -92,19 +89,15 @@ module Google # language_codes are returned. # The maximum number of allowed characters is 255. # @param [Fixnum] page_size - # Required. - # Completion result count. + # Required. Completion result count. # The maximum allowed page size is 10. # @param [String] query - # Required. - # The query used to generate suggestions. + # Required. The query used to generate suggestions. # The maximum number of allowed characters is 255. # @param [String] scope - # Optional. - # The scope of the completion. The defaults is CompletionScope.PUBLIC. + # Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. # @param [String] type - # Optional. - # The completion topic. The default is CompletionType.COMBINED. + # Optional. The completion topic. The default is CompletionType.COMBINED. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -180,8 +173,7 @@ module Google # Creates a new company entity. # @param [String] parent - # Required. - # Resource name of the project under which the company is created. + # Required. Resource name of the project under which the company is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::CreateCompanyRequest] create_company_request_object @@ -217,8 +209,7 @@ module Google # Deletes specified company. # Prerequisite: The company has no jobs associated with it. # @param [String] name - # Required. - # The resource name of the company to be deleted. + # Required. The resource name of the company to be deleted. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] fields @@ -250,8 +241,7 @@ module Google # Retrieves specified company. # @param [String] name - # Required. - # The resource name of the company to be retrieved. + # Required. The resource name of the company to be retrieved. # The format is "projects/`project_id`/companies/`company_id`", for example, # "projects/api-test-project/companies/foo". # @param [String] fields @@ -283,20 +273,16 @@ module Google # Lists all companies associated with the service account. # @param [String] parent - # Required. - # Resource name of the project under which the company is created. + # Required. Resource name of the project under which the company is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Fixnum] page_size - # Optional. - # The maximum number of companies to be returned, at most 100. + # Optional. The maximum number of companies to be returned, at most 100. # Default is 100 if a non-positive number is provided. # @param [String] page_token - # Optional. - # The starting indicator from which to return results. + # Optional. The starting indicator from which to return results. # @param [Boolean] require_open_jobs - # Optional. - # Set to true if the companies requested must have open jobs. + # Optional. Set to true if the companies requested must have open jobs. # Defaults to false. # If true, at most page_size of companies are fetched, among which # only those with open jobs are returned. @@ -371,8 +357,7 @@ module Google # Deletes a list of Jobs by filter. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::BatchDeleteJobsRequest] batch_delete_jobs_request_object @@ -409,8 +394,7 @@ module Google # Typically, the job becomes searchable within 10 seconds, but it may take # up to 5 minutes. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::CreateJobRequest] create_job_request_object @@ -447,8 +431,7 @@ module Google # Typically, the job becomes unsearchable within 10 seconds, but it may take # up to 5 minutes. # @param [String] name - # Required. - # The resource name of the job to be deleted. + # Required. The resource name of the job to be deleted. # The format is "projects/`project_id`/jobs/`job_id`", # for example, "projects/api-test-project/jobs/1234". # @param [String] fields @@ -481,8 +464,7 @@ module Google # Retrieves the specified job, whose status is OPEN or recently EXPIRED # within the last 90 days. # @param [String] name - # Required. - # The resource name of the job to retrieve. + # Required. The resource name of the job to retrieve. # The format is "projects/`project_id`/jobs/`job_id`", # for example, "projects/api-test-project/jobs/1234". # @param [String] fields @@ -514,13 +496,11 @@ module Google # Lists jobs by filter. # @param [String] parent - # Required. - # The resource name of the project under which the job is created. + # Required. The resource name of the project under which the job is created. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [String] filter - # Required. - # The filter string specifies the jobs to be enumerated. + # Required. The filter string specifies the jobs to be enumerated. # Supported operator: =, AND # The fields eligible for filtering are: # * `companyName` (Required) @@ -530,19 +510,16 @@ module Google # * companyName = "projects/api-test-project/companies/123" AND requisitionId # = "req-1" # @param [String] job_view - # Optional. - # The desired job attributes returned for jobs in the + # Optional. The desired job attributes returned for jobs in the # search response. Defaults to JobView.JOB_VIEW_FULL if no value is # specified. # @param [Fixnum] page_size - # Optional. - # The maximum number of jobs to be returned per page of results. + # Optional. The maximum number of jobs to be returned per page of results. # If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed # page size is 1000. Otherwise, the maximum allowed page size is 100. # Default is 100 if empty or a number < 1 is specified. # @param [String] page_token - # Optional. - # The starting point of a query result. + # Optional. The starting point of a query result. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -620,8 +597,7 @@ module Google # present in the database, and only returns jobs that the caller has # permission to search against. # @param [String] parent - # Required. - # The resource name of the project to search within. + # Required. The resource name of the project to search within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::SearchJobsRequest] search_jobs_request_object @@ -663,8 +639,7 @@ module Google # present in the database, and only returns jobs the caller has # permission to search against. # @param [String] parent - # Required. - # The resource name of the project to search within. + # Required. The resource name of the project to search within. # The format is "projects/`project_id`", for example, # "projects/api-test-project". # @param [Google::Apis::JobsV3p1beta1::SearchJobsRequest] search_jobs_request_object diff --git a/generated/google/apis/people_v1.rb b/generated/google/apis/people_v1.rb index de7dff34d..644ad042d 100644 --- a/generated/google/apis/people_v1.rb +++ b/generated/google/apis/people_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/people/ module PeopleV1 VERSION = 'V1' - REVISION = '20190717' + REVISION = '20190718' # See, edit, download, and permanently delete your contacts AUTH_CONTACTS = 'https://www.googleapis.com/auth/contacts' diff --git a/generated/google/apis/people_v1/classes.rb b/generated/google/apis/people_v1/classes.rb index 1351fab20..04b21815d 100644 --- a/generated/google/apis/people_v1/classes.rb +++ b/generated/google/apis/people_v1/classes.rb @@ -514,6 +514,29 @@ module Google end end + # The response for deleteing a contact's photo. + class DeleteContactPhotoResponse + include Google::Apis::Core::Hashable + + # Information about a person merged from various data sources such as the + # authenticated user's contacts and profile data. + # Most fields can have multiple items. The items in a field have no guaranteed + # order, but each non-empty field is guaranteed to have exactly one field with + # `metadata.primary` set to true. + # Corresponds to the JSON property `person` + # @return [Google::Apis::PeopleV1::Person] + attr_accessor :person + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @person = args[:person] if args.key?(:person) + end + end + # A read-only G Suite Domain membership. class DomainMembership include Google::Apis::Core::Hashable @@ -2101,6 +2124,88 @@ module Google end end + # A request to update an existing contact's photo. + # All requests must have a valid photo format: JPEG or PNG. + class UpdateContactPhotoRequest + include Google::Apis::Core::Hashable + + # **Optional.** Not specifying any fields will skip the post mutate read. + # A field mask to restrict which fields on the person are + # returned. Multiple fields can be specified by separating them with commas. + # Valid values are: + # * addresses + # * ageRanges + # * biographies + # * birthdays + # * braggingRights + # * coverPhotos + # * emailAddresses + # * events + # * genders + # * imClients + # * interests + # * locales + # * memberships + # * metadata + # * names + # * nicknames + # * occupations + # * organizations + # * phoneNumbers + # * photos + # * relations + # * relationshipInterests + # * relationshipStatuses + # * residences + # * sipAddresses + # * skills + # * taglines + # * urls + # * userDefined + # Corresponds to the JSON property `personFields` + # @return [String] + attr_accessor :person_fields + + # Raw photo bytes + # Corresponds to the JSON property `photoBytes` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :photo_bytes + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @person_fields = args[:person_fields] if args.key?(:person_fields) + @photo_bytes = args[:photo_bytes] if args.key?(:photo_bytes) + end + end + + # The response for updating a contact's photo. + class UpdateContactPhotoResponse + include Google::Apis::Core::Hashable + + # Information about a person merged from various data sources such as the + # authenticated user's contacts and profile data. + # Most fields can have multiple items. The items in a field have no guaranteed + # order, but each non-empty field is guaranteed to have exactly one field with + # `metadata.primary` set to true. + # Corresponds to the JSON property `person` + # @return [Google::Apis::PeopleV1::Person] + attr_accessor :person + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @person = args[:person] if args.key?(:person) + end + end + # A person's associated URLs. class Url include Google::Apis::Core::Hashable diff --git a/generated/google/apis/people_v1/representations.rb b/generated/google/apis/people_v1/representations.rb index a7894d5cd..c736ad878 100644 --- a/generated/google/apis/people_v1/representations.rb +++ b/generated/google/apis/people_v1/representations.rb @@ -100,6 +100,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class DeleteContactPhotoResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class DomainMembership class Representation < Google::Apis::Core::JsonRepresentation; end @@ -310,6 +316,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class UpdateContactPhotoRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class UpdateContactPhotoResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Url class Representation < Google::Apis::Core::JsonRepresentation; end @@ -457,6 +475,14 @@ module Google end end + class DeleteContactPhotoResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :person, as: 'person', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation + + end + end + class DomainMembership # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -886,6 +912,22 @@ module Google end end + class UpdateContactPhotoRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :person_fields, as: 'personFields' + property :photo_bytes, :base64 => true, as: 'photoBytes' + end + end + + class UpdateContactPhotoResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :person, as: 'person', class: Google::Apis::PeopleV1::Person, decorator: Google::Apis::PeopleV1::Person::Representation + + end + end + class Url # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/people_v1/service.rb b/generated/google/apis/people_v1/service.rb index 2bcdb0011..ce3d47664 100644 --- a/generated/google/apis/people_v1/service.rb +++ b/generated/google/apis/people_v1/service.rb @@ -354,6 +354,71 @@ module Google execute_or_queue_command(command, &block) end + # Delete a contact's photo. + # @param [String] resource_name + # The resource name of the contact whose photo will be deleted. + # @param [String] person_fields + # **Optional.** Not specifying any fields will skip the post mutate read. + # A field mask to restrict which fields on the person are + # returned. Multiple fields can be specified by separating them with commas. + # Valid values are: + # * addresses + # * ageRanges + # * biographies + # * birthdays + # * braggingRights + # * coverPhotos + # * emailAddresses + # * events + # * genders + # * imClients + # * interests + # * locales + # * memberships + # * metadata + # * names + # * nicknames + # * occupations + # * organizations + # * phoneNumbers + # * photos + # * relations + # * relationshipInterests + # * relationshipStatuses + # * residences + # * sipAddresses + # * skills + # * taglines + # * urls + # * userDefined + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::PeopleV1::DeleteContactPhotoResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::PeopleV1::DeleteContactPhotoResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_person_contact_photo(resource_name, person_fields: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1/{+resourceName}:deleteContactPhoto', options) + command.response_representation = Google::Apis::PeopleV1::DeleteContactPhotoResponse::Representation + command.response_class = Google::Apis::PeopleV1::DeleteContactPhotoResponse + command.params['resourceName'] = resource_name unless resource_name.nil? + command.query['personFields'] = person_fields unless person_fields.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Provides information about a person by specifying a resource name. Use # `people/me` to indicate the authenticated user. #
@@ -582,6 +647,39 @@ module Google execute_or_queue_command(command, &block) end + # Update a contact's photo. + # @param [String] resource_name + # Person resource name + # @param [Google::Apis::PeopleV1::UpdateContactPhotoRequest] update_contact_photo_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::PeopleV1::UpdateContactPhotoResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::PeopleV1::UpdateContactPhotoResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_person_contact_photo(resource_name, update_contact_photo_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'v1/{+resourceName}:updateContactPhoto', options) + command.request_representation = Google::Apis::PeopleV1::UpdateContactPhotoRequest::Representation + command.request_object = update_contact_photo_request_object + command.response_representation = Google::Apis::PeopleV1::UpdateContactPhotoResponse::Representation + command.response_class = Google::Apis::PeopleV1::UpdateContactPhotoResponse + command.params['resourceName'] = resource_name unless resource_name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Provides a list of the authenticated user's contacts merged with any # connected profiles. #