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 > ApplicationServiceClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
ApplicationServiceTransport | The transport used by the client instance. |
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>)
Instantiates the application service client.
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 |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
application_path
application_path(project: str, tenant: str, profile: str, application: str)
Returns a fully-qualified application string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
company_path
company_path(project: str, tenant: str, company: str)
Returns a fully-qualified company string.
create_application
create_application(request: Optional[Union[google.cloud.talent_v4beta1.types.application_service.CreateApplicationRequest, dict]] = None, *, parent: Optional[str] = None, application: Optional[google.cloud.talent_v4beta1.types.application.Application] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new application entity.
from google.cloud import talent_v4beta1
def sample_create_application():
# Create a client
client = talent_v4beta1.ApplicationServiceClient()
# Initialize request argument(s)
application = talent_v4beta1.Application()
application.external_id = "external_id_value"
application.job = "job_value"
application.stage = "STARTED"
request = talent_v4beta1.CreateApplicationRequest(
parent="parent_value",
application=application,
)
# Make the request
response = client.create_application(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.CreateApplicationRequest, dict]
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 |
application |
google.cloud.talent_v4beta1.types.Application
Required. The application to be created. This corresponds to the |
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. |
Type | Description |
google.cloud.talent_v4beta1.types.Application | Resource that represents a job application record of a candidate. |
delete_application
delete_application(request: Optional[Union[google.cloud.talent_v4beta1.types.application_service.DeleteApplicationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes specified application.
from google.cloud import talent_v4beta1
def sample_delete_application():
# Create a client
client = talent_v4beta1.ApplicationServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.DeleteApplicationRequest(
name="name_value",
)
# Make the request
client.delete_application(request=request)
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.DeleteApplicationRequest, dict]
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 |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ApplicationServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ApplicationServiceClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ApplicationServiceClient | The constructed client. |
get_application
get_application(request: Optional[Union[google.cloud.talent_v4beta1.types.application_service.GetApplicationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves specified application.
from google.cloud import talent_v4beta1
def sample_get_application():
# Create a client
client = talent_v4beta1.ApplicationServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.GetApplicationRequest(
name="name_value",
)
# Make the request
response = client.get_application(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.GetApplicationRequest, dict]
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 |
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. |
Type | Description |
google.cloud.talent_v4beta1.types.Application | Resource that represents a job application record of a candidate. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
job_path
job_path(project: str, tenant: str, job: str)
Returns a fully-qualified job string.
list_applications
list_applications(request: Optional[Union[google.cloud.talent_v4beta1.types.application_service.ListApplicationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all applications associated with the profile.
from google.cloud import talent_v4beta1
def sample_list_applications():
# Create a client
client = talent_v4beta1.ApplicationServiceClient()
# Initialize request argument(s)
request = talent_v4beta1.ListApplicationsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_applications(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.ListApplicationsRequest, dict]
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 |
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. |
Type | Description |
google.cloud.talent_v4beta1.services.application_service.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)
Parses a application path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_company_path
parse_company_path(path: str)
Parses a company path into its component segments.
parse_job_path
parse_job_path(path: str)
Parses a job path into its component segments.
parse_profile_path
parse_profile_path(path: str)
Parses a profile path into its component segments.
profile_path
profile_path(project: str, tenant: str, profile: str)
Returns a fully-qualified profile string.
update_application
update_application(request: Optional[Union[google.cloud.talent_v4beta1.types.application_service.UpdateApplicationRequest, dict]] = None, *, application: Optional[google.cloud.talent_v4beta1.types.application.Application] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates specified application.
from google.cloud import talent_v4beta1
def sample_update_application():
# Create a client
client = talent_v4beta1.ApplicationServiceClient()
# Initialize request argument(s)
application = talent_v4beta1.Application()
application.external_id = "external_id_value"
application.job = "job_value"
application.stage = "STARTED"
request = talent_v4beta1.UpdateApplicationRequest(
application=application,
)
# Make the request
response = client.update_application(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.talent_v4beta1.types.UpdateApplicationRequest, dict]
The request object. Request for updating a specified application. |
application |
google.cloud.talent_v4beta1.types.Application
Required. The application resource to replace the current resource in the system. This corresponds to the |
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. |
Type | Description |
google.cloud.talent_v4beta1.types.Application | Resource that represents a job application record of a candidate. |