Class ApplicationServiceClient (1.0.0)

ApplicationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.application_service.transports.base.ApplicationServiceTransport]] = 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 application management, including CRUD and enumeration.

Inheritance

builtins.object > ApplicationServiceClient

Methods

ApplicationServiceClient

ApplicationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.application_service.transports.base.ApplicationServiceTransport]] = 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 application 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, `.ApplicationServiceTransport`] 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.

application_path

application_path(project: str, tenant: str, profile: str, application: str)

Return a fully-qualified application string.

create_application

create_application(request: Optional[google.cloud.talent_v4beta1.types.application_service.CreateApplicationRequest] = None, *, parent: Optional[str] = None, application: Optional[google.cloud.talent_v4beta1.types.application.Application] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new application entity.

Parameters

Name	Description
request	`.application_service.CreateApplicationRequest` The request object. The Request of the CreateApplication method.
parent	`str` Required. Resource name of the profile under which the application is created. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}". For example, "projects/foo/tenants/bar/profiles/baz". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
application	`.gct_application.Application` Required. The application to be created. This corresponds to the `application` 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_application.Application`	Resource that represents a job application record of a candidate.

delete_application

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

Deletes specified application.

Parameters

Name	Description
request	`.application_service.DeleteApplicationRequest` The request object. Request to delete a application.
name	`str` Required. The resource name of the application to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux". 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_application

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

Retrieves specified application.

Parameters

Name	Description
request	`.application_service.GetApplicationRequest` The request object. Request for getting a application by name.
name	`str` Required. The resource name of the application to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}/applications/{application_id}". For example, "projects/foo/tenants/bar/profiles/baz/applications/qux". 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
`.application.Application`	Resource that represents a job application record of a candidate.

list_applications

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

Lists all applications associated with the profile.

Parameters

Name	Description
request	`.application_service.ListApplicationsRequest` The request object. List applications for which the client has ACL visibility.
parent	`str` Required. Resource name of the profile under which the application is created. The format is "projects/{project_id}/tenants/{tenant_id}/profiles/{profile_id}", for example, "projects/foo/tenants/bar/profiles/baz". 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.ListApplicationsPager`	The List applications response object. Iterating over this object will yield results and resolve additional pages automatically.

parse_application_path

parse_application_path(path: str)

Parse a application path into its component segments.

update_application

update_application(request: Optional[google.cloud.talent_v4beta1.types.application_service.UpdateApplicationRequest] = None, *, application: Optional[google.cloud.talent_v4beta1.types.application.Application] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates specified application.

Parameters

Name	Description
request	`.application_service.UpdateApplicationRequest` The request object. Request for updating a specified application.
application	`.gct_application.Application` Required. The application resource to replace the current resource in the system. This corresponds to the `application` 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_application.Application`	Resource that represents a job application record of a candidate.