Cloud Talent Solution V4beta1 API - Class Google::Cloud::Talent::V4beta1::ProfileQuery

Reference documentation and code samples for the Cloud Talent Solution V4beta1 API class Google::Cloud::Talent::V4beta1::ProfileQuery.

Filters to apply when performing the search query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#application_date_filters

def application_date_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationDateFilter>
Returns

#application_date_filters=

def application_date_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationDateFilter>
Parameter
Returns

#application_job_filters

def application_job_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationJobFilter>
Returns

#application_job_filters=

def application_job_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationJobFilter>
Parameter
Returns

#application_outcome_notes_filters

def application_outcome_notes_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter>
Returns

#application_outcome_notes_filters=

def application_outcome_notes_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter>
Parameter
Returns

#availability_filters

def availability_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::AvailabilityFilter>
Returns

#availability_filters=

def availability_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::AvailabilityFilter>
Parameter
Returns

#candidate_availability_filter

def candidate_availability_filter() -> ::Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter
Returns
  • (::Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter) — Deprecated. Use availability_filters instead.

    The candidate availability filter which filters based on availability signals.

    Signal 1: Number of days since most recent job application. See [Availability.JobApplicationAvailabilitySignal][google.cloud.talent.v4beta1.Availability.JobApplicationAvailabilitySignal] for the details of this signal.

    Signal 2: Number of days since last profile update. See [Availability.ProfileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] for the details of this signal.

    The candidate availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate's potential qualification / interest / close ability for a specific job.

#candidate_availability_filter=

def candidate_availability_filter=(value) -> ::Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter
Parameter
  • value (::Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter) — Deprecated. Use availability_filters instead.

    The candidate availability filter which filters based on availability signals.

    Signal 1: Number of days since most recent job application. See [Availability.JobApplicationAvailabilitySignal][google.cloud.talent.v4beta1.Availability.JobApplicationAvailabilitySignal] for the details of this signal.

    Signal 2: Number of days since last profile update. See [Availability.ProfileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] for the details of this signal.

    The candidate availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate's potential qualification / interest / close ability for a specific job.

Returns
  • (::Google::Cloud::Talent::V4beta1::CandidateAvailabilityFilter) — Deprecated. Use availability_filters instead.

    The candidate availability filter which filters based on availability signals.

    Signal 1: Number of days since most recent job application. See [Availability.JobApplicationAvailabilitySignal][google.cloud.talent.v4beta1.Availability.JobApplicationAvailabilitySignal] for the details of this signal.

    Signal 2: Number of days since last profile update. See [Availability.ProfileUpdateAvailabilitySignal][google.cloud.talent.v4beta1.Availability.ProfileUpdateAvailabilitySignal] for the details of this signal.

    The candidate availability filter helps a recruiter understand if a specific candidate is likely to be actively seeking new job opportunities based on an aggregated set of signals. Specifically, the intent is NOT to indicate the candidate's potential qualification / interest / close ability for a specific job.

#custom_attribute_filter

def custom_attribute_filter() -> ::String
Returns
  • (::String) — This filter specifies a structured syntax to match against the Profile.custom_attributes that are marked as filterable.

    The syntax for this expression is a subset of Google SQL syntax.

    String custom attributes: supported operators are =, != where the left of the operator is a custom field key and the right of the operator is a string (surrounded by quotes) value.

    Numeric custom attributes: Supported operators are '>', '<' or '=' operators where the left of the operator is a custom field key and the right of the operator is a numeric value.

    Supported functions are LOWER(

    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"), and there can be a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length.

    Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1))

#custom_attribute_filter=

def custom_attribute_filter=(value) -> ::String
Parameter
  • value (::String) — This filter specifies a structured syntax to match against the Profile.custom_attributes that are marked as filterable.

    The syntax for this expression is a subset of Google SQL syntax.

    String custom attributes: supported operators are =, != where the left of the operator is a custom field key and the right of the operator is a string (surrounded by quotes) value.

    Numeric custom attributes: Supported operators are '>', '<' or '=' operators where the left of the operator is a custom field key and the right of the operator is a numeric value.

    Supported functions are LOWER(

    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"), and there can be a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length.

    Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1))

Returns
  • (::String) — This filter specifies a structured syntax to match against the Profile.custom_attributes that are marked as filterable.

    The syntax for this expression is a subset of Google SQL syntax.

    String custom attributes: supported operators are =, != where the left of the operator is a custom field key and the right of the operator is a string (surrounded by quotes) value.

    Numeric custom attributes: Supported operators are '>', '<' or '=' operators where the left of the operator is a custom field key and the right of the operator is a numeric value.

    Supported functions are LOWER(

    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"), and there can be a maximum of 50 comparisons/functions in the expression. The expression must be < 2000 characters in length.

    Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1))

#education_filters

def education_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::EducationFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::EducationFilter>) — Education filter specifies education of profiles to match on.

    If an education filter isn't specified, profiles with any education are retrieved.

    If multiple education filters are specified, profiles that match any education filters are retrieved.

    If EducationFilter.negated is specified, the result won't contain profiles that match the educations.

    For example, search for profiles with a master degree.

#education_filters=

def education_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::EducationFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::EducationFilter>) — Education filter specifies education of profiles to match on.

    If an education filter isn't specified, profiles with any education are retrieved.

    If multiple education filters are specified, profiles that match any education filters are retrieved.

    If EducationFilter.negated is specified, the result won't contain profiles that match the educations.

    For example, search for profiles with a master degree.

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::EducationFilter>) — Education filter specifies education of profiles to match on.

    If an education filter isn't specified, profiles with any education are retrieved.

    If multiple education filters are specified, profiles that match any education filters are retrieved.

    If EducationFilter.negated is specified, the result won't contain profiles that match the educations.

    For example, search for profiles with a master degree.

#employer_filters

def employer_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::EmployerFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::EmployerFilter>) — Employer filter specifies employers of profiles to match on.

    If an employer filter isn't specified, profiles with any employers are retrieved.

    If multiple employer filters are specified, profiles with any matching employers are retrieved.

    If EmployerFilter.negated is specified, the result won't contain profiles that match the employers.

    For example, search for profiles that have working experience at "Google LLC".

#employer_filters=

def employer_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::EmployerFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::EmployerFilter>) — Employer filter specifies employers of profiles to match on.

    If an employer filter isn't specified, profiles with any employers are retrieved.

    If multiple employer filters are specified, profiles with any matching employers are retrieved.

    If EmployerFilter.negated is specified, the result won't contain profiles that match the employers.

    For example, search for profiles that have working experience at "Google LLC".

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::EmployerFilter>) — Employer filter specifies employers of profiles to match on.

    If an employer filter isn't specified, profiles with any employers are retrieved.

    If multiple employer filters are specified, profiles with any matching employers are retrieved.

    If EmployerFilter.negated is specified, the result won't contain profiles that match the employers.

    For example, search for profiles that have working experience at "Google LLC".

#hirable_filter

def hirable_filter() -> ::Google::Protobuf::BoolValue
Returns

#hirable_filter=

def hirable_filter=(value) -> ::Google::Protobuf::BoolValue
Parameter
Returns

#job_title_filters

def job_title_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::JobTitleFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::JobTitleFilter>) — Job title filter specifies job titles of profiles to match on.

    If a job title isn't specified, profiles with any titles are retrieved.

    If multiple values are specified, profiles are retrieved with any of the specified job titles.

    If JobTitleFilter.negated is specified, the result won't contain profiles with the job titles.

    For example, search for profiles with a job title "Product Manager".

#job_title_filters=

def job_title_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::JobTitleFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::JobTitleFilter>) — Job title filter specifies job titles of profiles to match on.

    If a job title isn't specified, profiles with any titles are retrieved.

    If multiple values are specified, profiles are retrieved with any of the specified job titles.

    If JobTitleFilter.negated is specified, the result won't contain profiles with the job titles.

    For example, search for profiles with a job title "Product Manager".

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::JobTitleFilter>) — Job title filter specifies job titles of profiles to match on.

    If a job title isn't specified, profiles with any titles are retrieved.

    If multiple values are specified, profiles are retrieved with any of the specified job titles.

    If JobTitleFilter.negated is specified, the result won't contain profiles with the job titles.

    For example, search for profiles with a job title "Product Manager".

#location_filters

def location_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::LocationFilter>
Returns

#location_filters=

def location_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::LocationFilter>
Parameter
Returns

#person_name_filters

def person_name_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::PersonNameFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::PersonNameFilter>) — Person name filter specifies person name of profiles to match on.

    If multiple person name filters are specified, profiles that match any person name filters are retrieved.

    For example, search for profiles of candidates with name "John Smith".

#person_name_filters=

def person_name_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::PersonNameFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::PersonNameFilter>) — Person name filter specifies person name of profiles to match on.

    If multiple person name filters are specified, profiles that match any person name filters are retrieved.

    For example, search for profiles of candidates with name "John Smith".

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::PersonNameFilter>) — Person name filter specifies person name of profiles to match on.

    If multiple person name filters are specified, profiles that match any person name filters are retrieved.

    For example, search for profiles of candidates with name "John Smith".

#query

def query() -> ::String
Returns
  • (::String) — Keywords to match any text fields of profiles.

    For example, "software engineer in Palo Alto".

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Keywords to match any text fields of profiles.

    For example, "software engineer in Palo Alto".

Returns
  • (::String) — Keywords to match any text fields of profiles.

    For example, "software engineer in Palo Alto".

#skill_filters

def skill_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::SkillFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::SkillFilter>) — Skill filter specifies skill of profiles to match on.

    If a skill filter isn't specified, profiles with any skills are retrieved.

    If multiple skill filters are specified, profiles that match any skill filters are retrieved.

    If SkillFilter.negated is specified, the result won't contain profiles that match the skills.

    For example, search for profiles that have "Java" and "Python" in skill list.

#skill_filters=

def skill_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::SkillFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::SkillFilter>) — Skill filter specifies skill of profiles to match on.

    If a skill filter isn't specified, profiles with any skills are retrieved.

    If multiple skill filters are specified, profiles that match any skill filters are retrieved.

    If SkillFilter.negated is specified, the result won't contain profiles that match the skills.

    For example, search for profiles that have "Java" and "Python" in skill list.

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::SkillFilter>) — Skill filter specifies skill of profiles to match on.

    If a skill filter isn't specified, profiles with any skills are retrieved.

    If multiple skill filters are specified, profiles that match any skill filters are retrieved.

    If SkillFilter.negated is specified, the result won't contain profiles that match the skills.

    For example, search for profiles that have "Java" and "Python" in skill list.

#time_filters

def time_filters() -> ::Array<::Google::Cloud::Talent::V4beta1::TimeFilter>
Returns

#time_filters=

def time_filters=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::TimeFilter>
Parameter
Returns

#work_experience_filter

def work_experience_filter() -> ::Array<::Google::Cloud::Talent::V4beta1::WorkExperienceFilter>
Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::WorkExperienceFilter>) — Work experience filter specifies the total working experience of profiles to match on.

    If a work experience filter isn't specified, profiles with any professional experience are retrieved.

    If multiple work experience filters are specified, profiles that match any work experience filters are retrieved.

    For example, search for profiles with 10 years of work experience.

#work_experience_filter=

def work_experience_filter=(value) -> ::Array<::Google::Cloud::Talent::V4beta1::WorkExperienceFilter>
Parameter
  • value (::Array<::Google::Cloud::Talent::V4beta1::WorkExperienceFilter>) — Work experience filter specifies the total working experience of profiles to match on.

    If a work experience filter isn't specified, profiles with any professional experience are retrieved.

    If multiple work experience filters are specified, profiles that match any work experience filters are retrieved.

    For example, search for profiles with 10 years of work experience.

Returns
  • (::Array<::Google::Cloud::Talent::V4beta1::WorkExperienceFilter>) — Work experience filter specifies the total working experience of profiles to match on.

    If a work experience filter isn't specified, profiles with any professional experience are retrieved.

    If multiple work experience filters are specified, profiles that match any work experience filters are retrieved.

    For example, search for profiles with 10 years of work experience.