Class ProfileServiceClient (1.0.0)

ProfileServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.profile_service.transports.base.ProfileServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Inheritance

builtins.object > ProfileServiceClient

Methods

ProfileServiceClient

ProfileServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.profile_service.transports.base.ProfileServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the profile service client.

Parameters

Name	Description
credentials	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, `.ProfileServiceTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`client_options_lib.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

create_profile

create_profile(request: Optional[google.cloud.talent_v4beta1.types.profile_service.CreateProfileRequest] = None, *, parent: Optional[str] = None, profile: Optional[google.cloud.talent_v4beta1.types.profile.Profile] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates and returns a new profile.

Parameters

Name	Description
request	`.profile_service.CreateProfileRequest` The request object. Create profile request.
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". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
profile	`.gct_profile.Profile` Required. The profile to be created. This corresponds to the `profile` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`.gct_profile.Profile`	A resource that represents the profile for a job candidate (also referred to as a "single-source profile").

delete_profile

delete_profile(request: Optional[google.cloud.talent_v4beta1.types.profile_service.DeleteProfileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters

Name	Description
request	`.profile_service.DeleteProfileRequest` The request object. Delete profile request.
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". This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
{@api.name}	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
{@api.name}	The constructed client.

get_profile

get_profile(request: Optional[google.cloud.talent_v4beta1.types.profile_service.GetProfileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the specified profile.

Parameters

Name	Description
request	`.profile_service.GetProfileRequest` The request object. Get profile request.
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". This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`.profile.Profile`	A resource that represents the profile for a job candidate (also referred to as a "single-source profile").

list_profiles

list_profiles(request: Optional[google.cloud.talent_v4beta1.types.profile_service.ListProfilesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists profiles by filter. The order is unspecified.

Parameters

Name	Description
request	`.profile_service.ListProfilesRequest` The request object. List profiles request.
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". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`.pagers.ListProfilesPager`	The List profiles response object. Iterating over this object will yield results and resolve additional pages automatically.

parse_profile_path

parse_profile_path(path: str)

Parse a profile path into its component segments.

profile_path

profile_path(project: str, tenant: str, profile: str)

Return a fully-qualified profile string.

search_profiles

search_profiles(request: Optional[google.cloud.talent_v4beta1.types.profile_service.SearchProfilesRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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 xref_SearchProfilesRequest for more information.

Parameters

Name	Description
request	`.profile_service.SearchProfilesRequest` The request object. The request body of the `SearchProfiles` call.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`.pagers.SearchProfilesPager`	Response of SearchProfiles method. Iterating over this object will yield results and resolve additional pages automatically.

update_profile

update_profile(request: Optional[google.cloud.talent_v4beta1.types.profile_service.UpdateProfileRequest] = None, *, profile: Optional[google.cloud.talent_v4beta1.types.profile.Profile] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified profile and returns the updated result.

Parameters

Name	Description
request	`.profile_service.UpdateProfileRequest` The request object. Update profile request
profile	`.gct_profile.Profile` Required. Profile to be updated. This corresponds to the `profile` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`.gct_profile.Profile`	A resource that represents the profile for a job candidate (also referred to as a "single-source profile").