Class ProfileServiceClient (0.6.2)

ProfileServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

A service that handles profile management, including profile CRUD, enumeration and search.

Inheritance

builtins.object > google.cloud.talent_v4beta1.gapic.profile_service_client.ProfileServiceClient > ProfileServiceClient

Methods

ProfileServiceClient

ProfileServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
NameDescription
channel grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

credentials google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

client_config dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

create_profile

create_profile(parent, profile, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Creates and returns a new profile.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

parent = client.tenant_path('[PROJECT]', '[TENANT]')

TODO: Initialize profile:

profile = {}

response = client.create_profile(parent, profile)

Parameters
NameDescription
parent str

Required. The name of the tenant this profile belongs to. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

profile Union[dict, Profile]

Required. The profile to be created. If a dict is provided, it must be of the same form as the protobuf message Profile

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

delete_profile

delete_profile(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Deletes the specified profile. Prerequisite: The profile has no associated applications or assignments associated.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

name = client.profile_path('[PROJECT]', '[TENANT]', '[PROFILE]')

client.delete_profile(name)

Parameters
NameDescription
name str

Required. Resource name of the profile to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ProfileServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ProfileServiceClientThe constructed client.

get_profile

get_profile(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Gets the specified profile.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

name = client.profile_path('[PROJECT]', '[TENANT]', '[PROFILE]')

response = client.get_profile(name)

Parameters
NameDescription
name str

Required. Resource name of the profile to get. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz".

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

list_profiles

list_profiles(parent, filter_=None, page_size=None, read_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Lists profiles by filter. The order is unspecified.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

parent = client.tenant_path('[PROJECT]', '[TENANT]')

Iterate over all results

for element in client.list_profiles(parent): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.list_profiles(parent).pages: ... for element in page: ... # process element ... pass

Parameters
NameDescription
parent str

Required. The resource name of the tenant under which the profile is created. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

filter_ str

The filter string specifies the profiles to be enumerated. Supported operator: =, AND The field(s) eligible for filtering are: - externalId - groupId externalId and groupId cannot be specified at the same time. If both externalId and groupId are provided, the API will return a bad request error. Sample Query: - externalId = "externalId-1" - groupId = "groupId-1"

page_size int

The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

read_mask Union[dict, FieldMask]

A field mask to specify the profile fields to be listed in response. All fields are listed if it is unset. Valid values are: - name If a dict is provided, it must be of the same form as the protobuf message FieldMask

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

profile_path

profile_path(project, tenant, profile)

Return a fully-qualified profile string.

search_profiles

search_profiles(parent, request_metadata, profile_query=None, page_size=None, offset=None, disable_spell_check=None, order_by=None, case_sensitive_sort=None, histogram_queries=None, result_set_id=None, strict_keywords_search=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Searches for profiles within a tenant.

For example, search by raw queries "software engineer in Mountain View" or search by structured filters (location filter, education filter, etc.).

See SearchProfilesRequest for more information.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

parent = client.tenant_path('[PROJECT]', '[TENANT]')

TODO: Initialize request_metadata:

request_metadata = {}

Iterate over all results

for element in client.search_profiles(parent, request_metadata): ... # process element ... pass

Alternatively:

Iterate over results one page at a time

for page in client.search_profiles(parent, request_metadata).pages: ... for element in page: ... # process element ... pass

Parameters
NameDescription
parent str

Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".

request_metadata Union[dict, RequestMetadata]

Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent. If a dict is provided, it must be of the same form as the protobuf message RequestMetadata

profile_query Union[dict, ProfileQuery]

Search query to execute. See ProfileQuery for more details. If a dict is provided, it must be of the same form as the protobuf message ProfileQuery

page_size int

The maximum number of resources contained in the underlying API response. If page streaming is performed per- resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

offset int

An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.

disable_spell_check bool

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query. For example, "enginee" is corrected to "engineer".

order_by str

The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are: - "relevance desc": By descending relevance, as determined by the API algorithms. - "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first). - "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first). - "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order. - "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order. - "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order. - "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.

case_sensitive_sort bool

When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).

histogram_queries list[Union[dict, HistogramQuery]]

A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types: - Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+. - String: string like "any string with backslash escape for quote(")." - Number: whole number and floating point number like 10, -1 and -0.01. - List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants: - MIN (minimum number similar to java Double.MIN_VALUE) - MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions: - bucket(start, end[, label]) Bucket build-in function creates a bucket with range of `start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets: - admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC". - locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York". - extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY". - postal_code: Postal code of profile which follows locale code. - country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB. - job_title: Normalized job titles specified in EmploymentHistory. - company_name: Normalized company name of profiles to match on. - institution: The school name. For example, "MIT", "University of California, Berkeley" - degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree. - experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive). - application_date: The application date specifies application start dates. See [ApplicationDateFilter` for more details. - application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details. - application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details. - hirable_status: Hirable status specifies the profile's hirable status. - string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"]. - numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions: - count(admin1) - count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")]) - count(string_custom_attribute["assigned_recruiter"]) - count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")]) If a dict is provided, it must be of the same form as the protobuf message HistogramQuery

result_set_id str

An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.

strict_keywords_search bool

This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query "as is" when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for "software engineer" might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating "software engineer" as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

tenant_path

tenant_path(project, tenant)

Return a fully-qualified tenant string.

update_profile

update_profile(profile, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Updates the specified profile and returns the updated result.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ProfileServiceClient()

TODO: Initialize profile:

profile = {}

response = client.update_profile(profile)

Parameters
NameDescription
profile Union[dict, Profile]

Required. Profile to be updated. If a dict is provided, it must be of the same form as the protobuf message Profile

update_mask Union[dict, FieldMask]

A field mask to specify the profile fields to update. A full update is performed if it is unset. If a dict is provided, it must be of the same form as the protobuf message FieldMask

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.