TenantServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.tenant_service.transports.base.TenantServiceTransport]] = 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 tenant management, including CRUD and enumeration.
Inheritance
builtins.object > TenantServiceClientMethods
TenantServiceClient
TenantServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4beta1.services.tenant_service.transports.base.TenantServiceTransport]] = 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 tenant 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, `.TenantServiceTransport`]
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 |
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. |
create_tenant
create_tenant(request: Optional[google.cloud.talent_v4beta1.types.tenant_service.CreateTenantRequest] = None, *, parent: Optional[str] = None, tenant: Optional[google.cloud.talent_v4beta1.types.tenant.Tenant] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new tenant entity.
Name | Description |
request |
`.tenant_service.CreateTenantRequest`
The request object. The Request of the CreateTenant method. |
parent |
`str`
Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo". This corresponds to the |
tenant |
`.gct_tenant.Tenant`
Required. The tenant 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 |
`.gct_tenant.Tenant` | A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups. |
delete_tenant
delete_tenant(request: Optional[google.cloud.talent_v4beta1.types.tenant_service.DeleteTenantRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes specified tenant.
Name | Description |
request |
`.tenant_service.DeleteTenantRequest`
The request object. Request to delete a tenant. |
name |
`str`
Required. The resource name of the tenant to be deleted. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 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 |
{@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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
{@api.name} | The constructed client. |
get_tenant
get_tenant(request: Optional[google.cloud.talent_v4beta1.types.tenant_service.GetTenantRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves specified tenant.
Name | Description |
request |
`.tenant_service.GetTenantRequest`
The request object. Request for getting a tenant by name. |
name |
`str`
Required. The resource name of the tenant to be retrieved. The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar". 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 |
`.tenant.Tenant` | A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups. |
list_tenants
list_tenants(request: Optional[google.cloud.talent_v4beta1.types.tenant_service.ListTenantsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists all tenants associated with the project.
Name | Description |
request |
`.tenant_service.ListTenantsRequest`
The request object. List tenants for which the client has ACL visibility. |
parent |
`str`
Required. Resource name of the project under which the tenant is created. The format is "projects/{project_id}", for example, "projects/foo". 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 |
`.pagers.ListTenantsPager` | The List tenants response object. Iterating over this object will yield results and resolve additional pages automatically. |
parse_tenant_path
parse_tenant_path(path: str)
Parse a tenant path into its component segments.
tenant_path
tenant_path(project: str, tenant: str)
Return a fully-qualified tenant string.
update_tenant
update_tenant(request: Optional[google.cloud.talent_v4beta1.types.tenant_service.UpdateTenantRequest] = None, *, tenant: Optional[google.cloud.talent_v4beta1.types.tenant.Tenant] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates specified tenant.
Name | Description |
request |
`.tenant_service.UpdateTenantRequest`
The request object. Request for updating a specified tenant. |
tenant |
`.gct_tenant.Tenant`
Required. The tenant 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 |
`.gct_tenant.Tenant` | A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like profiles. Customer may create multiple tenants to provide data isolation for different groups. |