Class ApplicationServiceClient (0.3.0)

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

A service that handles application management, including CRUD and enumeration.

Methods

ApplicationServiceClient

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

Constructor.

Parameters
Name	Description
`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.

application_path

application_path(project, tenant, profile, application)

Return a fully-qualified application string.

create_application

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

Creates a new application entity.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ApplicationServiceClient()

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

TODO: Initialize application:

application = {}

response = client.create_application(parent, application)

Parameters
Name	Description
`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/test-project/tenants/test-tenant/profiles/test-profile".
`application`	`Union[dict, Application]` Required. The application to be created. If a dict is provided, it must be of the same form as the protobuf message Application
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will not be retried.
`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
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

delete_application

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

Deletes specified application.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ApplicationServiceClient()

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

client.delete_application(name)

Parameters
Name	Description
`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/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will not be retried.
`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
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If 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
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`ApplicationServiceClient`	The 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
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`ApplicationServiceClient`	The constructed client.

get_application

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

Retrieves specified application.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ApplicationServiceClient()

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

response = client.get_application(name)

Parameters
Name	Description
`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/test-project/tenants/test-tenant/profiles/test-profile/applications/test-application".
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will not be retried.
`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
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

list_applications

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

Lists all applications associated with the profile.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ApplicationServiceClient()

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

Iterate over all results

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

Alternatively:

Iterate over results one page at a time

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

Parameters
Name	Description
`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/test-project/tenants/test-tenant/profiles/test-profile".
`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.
`retry`	`Optional[google.api_core.retry.Retry]` A retry object used to retry requests. If `None` is specified, requests will not be retried.
`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
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

profile_path

profile_path(project, tenant, profile)

Return a fully-qualified profile string.

update_application

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

Updates specified application.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.ApplicationServiceClient()

TODO: Initialize application:

application = {}

response = client.update_application(application)

Parameters
Name	Description
`application`	`Union[dict, Application]` Required. The application resource to replace the current resource in the system. If a dict is provided, it must be of the same form as the protobuf message Application
`update_mask`	`Union[dict, FieldMask]` Optional but strongly recommended for the best service experience. If `update_mask` is provided, only the specified fields in `application` are updated. Otherwise all the fields are updated. A field mask to specify the application fields to be updated. Only top level fields of `Application` are supported. 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 not be retried.
`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
Type	Description
`google.api_core.exceptions.GoogleAPICallError`	If the request failed for any reason.
`google.api_core.exceptions.RetryError`	If the request failed due to a retryable error and retry attempts failed.
`ValueError`	If the parameters are invalid.

Class ApplicationServiceClient (0.3.0)

Methods

ApplicationServiceClient

application_path

create_application

TODO: Initialize `application`:

delete_application

from_service_account_file

from_service_account_json

get_application

list_applications

Iterate over all results

Alternatively:

Iterate over results one page at a time

profile_path

update_application

TODO: Initialize `application`:

Class ApplicationServiceClient (0.3.0)

Methods

ApplicationServiceClient

application_path

create_application

TODO: Initialize application:

delete_application

from_service_account_file

from_service_account_json

get_application

list_applications

Iterate over all results

Alternatively:

Iterate over results one page at a time

profile_path

update_application

TODO: Initialize application:

TODO: Initialize `application`:

TODO: Initialize `application`: