Class: Google::Cloud::Talent::V4beta1::ProfileQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb

Overview

Filters to apply when performing the search query.

Instance Attribute Summary collapse

Instance Attribute Details

#application_date_filters ⇒ Array<Google::Cloud::Talent::V4beta1::ApplicationDateFilter>

Returns Optional.

The application date filters specify application date ranges to match on.

Returns:



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#application_job_filters ⇒ Array<Google::Cloud::Talent::V4beta1::ApplicationJobFilter>

Returns Optional.

The application job filters specify the job applied for in the application.

Returns:



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#application_outcome_notes_filters ⇒ Array<Google::Cloud::Talent::V4beta1::ApplicationOutcomeNotesFilter>

Returns Optional.

The application outcome notes filters specify the notes for the outcome of the job application.

Returns:



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#custom_attribute_filter ⇒ String

Returns Optional.

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() to perform case insensitive match and EMPTY() to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example "((A AND B AND C) OR NOT D) AND E"), 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) —

    Optional.

    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() to perform case insensitive match and EMPTY() to filter on the existence of a key.

    Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example "((A AND B AND C) OR NOT D) AND E"), 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))



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#education_filters ⇒ Array<Google::Cloud::Talent::V4beta1::EducationFilter>

Returns Optional.

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

    Optional.

    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.



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#employer_filters ⇒ Array<Google::Cloud::Talent::V4beta1::EmployerFilter>

Returns Optional.

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

    Optional.

    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".



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#hirable_filter ⇒ Google::Protobuf::BoolValue

Returns Optional.

The hirable filter specifies the profile's hirable status to match on.

Returns:



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#job_title_filters ⇒ Array<Google::Cloud::Talent::V4beta1::JobTitleFilter>

Returns Optional.

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

    Optional.

    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".



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#location_filters ⇒ Array<Google::Cloud::Talent::V4beta1::LocationFilter>

Returns Optional.

The location filter specifies geo-regions containing the profiles to search against.

If a location filter isn't specified, profiles fitting the other search criteria are retrieved regardless of where they're located.

If LocationFilter#negated is specified, the result doesn't contain profiles from that location.

For example, search for profiles with addresses in "New York City".

Returns:

  • (Array<Google::Cloud::Talent::V4beta1::LocationFilter>) —

    Optional.

    The location filter specifies geo-regions containing the profiles to search against.

    If a location filter isn't specified, profiles fitting the other search criteria are retrieved regardless of where they're located.

    If LocationFilter#negated is specified, the result doesn't contain profiles from that location.

    For example, search for profiles with addresses in "New York City".



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#query ⇒ String

Returns Optional.

Keywords to match any text fields of profiles.

For example, "software engineer in Palo Alto".

Returns:

  • (String) —

    Optional.

    Keywords to match any text fields of profiles.

    For example, "software engineer in Palo Alto".



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#skill_filters ⇒ Array<Google::Cloud::Talent::V4beta1::SkillFilter>

Returns Optional.

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

    Optional.

    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.



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#time_filters ⇒ Array<Google::Cloud::Talent::V4beta1::TimeFilter>

Returns Optional.

Time filter specifies the create/update timestamp of the profiles to match on.

For example, search for profiles created since "2018-1-1".

Returns:



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end

#work_experience_filter ⇒ Array<Google::Cloud::Talent::V4beta1::WorkExperienceFilter>

Returns Optional.

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

    Optional.

    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.



346
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/filters.rb', line 346

class ProfileQuery; end