Class: Google::Cloud::Talent::V4beta1::CompleteQueryRequest

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

Overview

Input only.

Auto-complete parameters.

Defined Under Namespace

Modules: CompletionScope, CompletionType

Instance Attribute Summary collapse

Instance Attribute Details

#company ⇒ String

Returns Optional.

If provided, restricts completion to specified company.

The format is "projects/project_id/tenants/tenant_id/companies/company_id", for example, "projects/api-test-project/tenants/foo/companies/bar".

Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar".

Returns:

  • (String) —

    Optional.

    If provided, restricts completion to specified company.

    The format is "projects/project_id/tenants/tenant_id/companies/company_id", for example, "projects/api-test-project/tenants/foo/companies/bar".

    Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project/companies/bar".



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#language_codes ⇒ Array<String>

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.

For CompletionType::JOB_TITLE type, only open jobs with the same language_codes are returned.

For CompletionType::COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.

For CompletionType::COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned.

The maximum number of allowed characters is 255.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#page_size ⇒ Integer

Returns Required.

Completion result count.

The maximum allowed page size is 10.

Returns:

  • (Integer) —

    Required.

    Completion result count.

    The maximum allowed page size is 10.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#parent ⇒ String

Returns Required.

Resource name of tenant the completion is performed within.

The format is "projects/project_id/tenants/tenant_id", for example, "projects/api-test-project/tenant/foo".

Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project".

Returns:

  • (String) —

    Required.

    Resource name of tenant the completion is performed within.

    The format is "projects/project_id/tenants/tenant_id", for example, "projects/api-test-project/tenant/foo".

    Tenant id is optional and the default tenant is used if unspecified, for example, "projects/api-test-project".



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#query ⇒ String

Returns Required.

The query used to generate suggestions.

The maximum number of allowed characters is 255.

Returns:

  • (String) —

    Required.

    The query used to generate suggestions.

    The maximum number of allowed characters is 255.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#scope ⇒ Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionScope

Returns Optional.

The scope of the completion. The defaults is CompletionScope::PUBLIC.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end

#type ⇒ Google::Cloud::Talent::V4beta1::CompleteQueryRequest::CompletionType

Returns Optional.

The completion topic. The default is CompletionType::COMBINED.

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/google/cloud/talent/v4beta1/doc/google/cloud/talent/v4beta1/completion_service.rb', line 91

class CompleteQueryRequest
  # Enum to specify the scope of completion.
  module CompletionScope
    # Default value.
    COMPLETION_SCOPE_UNSPECIFIED = 0

    # Suggestions are based only on the data provided by the client.
    TENANT = 1

    # Suggestions are based on all jobs data in the system that's visible to
    # the client
    PUBLIC = 2
  end

  # Enum to specify auto-completion topics.
  module CompletionType
    # Default value.
    COMPLETION_TYPE_UNSPECIFIED = 0

    # Only suggest job titles.
    JOB_TITLE = 1

    # Only suggest company names.
    COMPANY_NAME = 2

    # Suggest both job titles and company names.
    COMBINED = 3
  end
end