CompanyServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
A service that handles company management, including CRUD and enumeration.
Inheritance
builtins.object > google.cloud.talent_v4beta1.gapic.company_service_client.CompanyServiceClient > CompanyServiceClientMethods
CompanyServiceClient
CompanyServiceClient(
transport=None,
channel=None,
credentials=None,
client_config=None,
client_info=None,
client_options=None,
)
Constructor.
Name | Description |
channel |
grpc.Channel
DEPRECATED. A |
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 |
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 |
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. |
company_path
company_path(project, tenant, company)
Return a fully-qualified company string.
company_without_tenant_path
company_without_tenant_path(project, company)
Return a fully-qualified company_without_tenant string.
create_company
create_company(parent, company, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Creates a new company entity.
.. rubric:: Example
from google.cloud import talent_v4beta1
client = talent_v4beta1.CompanyServiceClient()
parent = client.project_path('[PROJECT]')
TODO: Initialize
company
:company = {}
response = client.create_company(parent, company)
Name | Description |
parent |
str
Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo". |
company |
Union[dict, Company]
Required. The company to be created. If a dict is provided, it must be of the same form as the protobuf message Company |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
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_company
delete_company(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Deletes specified company. Prerequisite: The company has no jobs associated with it.
.. rubric:: Example
from google.cloud import talent_v4beta1
client = talent_v4beta1.CompanyServiceClient()
name = client.company_path('[PROJECT]', '[TENANT]', '[COMPANY]')
client.delete_company(name)
Name | Description |
name |
str
Required. The resource name of the company to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar". |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CompanyServiceClient | 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CompanyServiceClient | The constructed client. |
get_company
get_company(name, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Retrieves specified company.
.. rubric:: Example
from google.cloud import talent_v4beta1
client = talent_v4beta1.CompanyServiceClient()
name = client.company_path('[PROJECT]', '[TENANT]', '[COMPANY]')
response = client.get_company(name)
Name | Description |
name |
str
Required. The resource name of the company to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar". If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar". |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
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_companies
list_companies(parent, page_size=None, require_open_jobs=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Lists all companies associated with the project.
.. rubric:: Example
from google.cloud import talent_v4beta1
client = talent_v4beta1.CompanyServiceClient()
parent = client.project_path('[PROJECT]')
Iterate over all results
for element in client.list_companies(parent): ... # process element ... pass
Alternatively:
Iterate over results one page at a time
for page in client.list_companies(parent).pages: ... for element in page: ... # process element ... pass
Name | Description |
parent |
str
Required. Resource name of the tenant under which the company is created. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, the default tenant will be used, for example, "projects/foo". |
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. |
require_open_jobs |
bool
Set to true if the companies requested must have open jobs. Defaults to false. If true, at most |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
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. |
project_path
project_path(project)
Return a fully-qualified project string.
tenant_path
tenant_path(project, tenant)
Return a fully-qualified tenant string.
update_company
update_company(company, update_mask=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)
Updates specified company.
.. rubric:: Example
from google.cloud import talent_v4beta1
client = talent_v4beta1.CompanyServiceClient()
TODO: Initialize
company
:company = {}
response = client.update_company(company)
Name | Description |
company |
Union[dict, Company]
Required. The company 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 Company |
update_mask |
Union[dict, FieldMask]
Strongly recommended for the best service experience. If |
retry |
Optional[google.api_core.retry.Retry]
A retry object used to retry requests. If |
timeout |
Optional[float]
The amount of time, in seconds, to wait for the request to complete. Note that if |
metadata |
Optional[Sequence[Tuple[str, str]]]
Additional metadata that is provided to the method. |
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. |