Class TenantServiceClient (0.3.0)

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

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

Methods

TenantServiceClient

TenantServiceClient(
    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.

create_tenant

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

Creates a new tenant entity.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.TenantServiceClient()

parent = client.project_path('[PROJECT]')

TODO: Initialize tenant:

tenant = {}

response = client.create_tenant(parent, tenant)

Parameters
Name	Description
`parent`	`str` Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
`tenant`	`Union[dict, Tenant]` Required. The tenant to be created. If a dict is provided, it must be of the same form as the protobuf message Tenant
`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_tenant

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

Deletes specified tenant.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.TenantServiceClient()

name = client.tenant_path('[PROJECT]', '[TENANT]')

client.delete_tenant(name)

Parameters
Name	Description
`name`	`str` Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/api-test-project/tenants/foo".
`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
`TenantServiceClient`	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
`TenantServiceClient`	The constructed client.

get_tenant

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

Retrieves specified tenant.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.TenantServiceClient()

name = client.tenant_path('[PROJECT]', '[TENANT]')

response = client.get_tenant(name)

Parameters
Name	Description
`name`	`str` Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/api-test-project/tenants/foo".
`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_tenants

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

Lists all tenants associated with the project.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.TenantServiceClient()

parent = client.project_path('[PROJECT]')

Iterate over all results

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

Alternatively:

Iterate over results one page at a time

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

Parameters
Name	Description
`parent`	`str` Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/api-test-project".
`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.

project_path

project_path(project)

Return a fully-qualified project string.

tenant_path

tenant_path(project, tenant)

Return a fully-qualified tenant string.

update_tenant

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

Updates specified tenant.

.. rubric:: Example

from google.cloud import talent_v4beta1

client = talent_v4beta1.TenantServiceClient()

TODO: Initialize tenant:

tenant = {}

response = client.update_tenant(tenant)

Parameters
Name	Description
`tenant`	`Union[dict, Tenant]` Required. The tenant 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 Tenant
`update_mask`	`Union[dict, FieldMask]` Optional but strongly recommended for the best service experience. If `update_mask` is provided, only the specified fields in `tenant` are updated. Otherwise all the fields are updated. A field mask to specify the tenant fields to be updated. Only top level fields of `Tenant` 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 TenantServiceClient (0.3.0)

Methods

TenantServiceClient

create_tenant

TODO: Initialize `tenant`:

delete_tenant

from_service_account_file

from_service_account_json

get_tenant

list_tenants

Iterate over all results

Alternatively:

Iterate over results one page at a time

project_path

tenant_path

update_tenant

TODO: Initialize `tenant`:

Class TenantServiceClient (0.3.0)

Methods

TenantServiceClient

create_tenant

TODO: Initialize tenant:

delete_tenant

from_service_account_file

from_service_account_json

get_tenant

list_tenants

Iterate over all results

Alternatively:

Iterate over results one page at a time

project_path

tenant_path

update_tenant

TODO: Initialize tenant:

TODO: Initialize `tenant`:

TODO: Initialize `tenant`: