Class TenantServiceClient (2.5.2)

TenantServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4.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.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`TenantServiceTransport`	The transport used by the client instance.

Methods

TenantServiceClient

TenantServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.talent_v4.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>)

Instantiates the tenant service client.

Parameters
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`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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.

Exceptions
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.

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.

create_tenant

create_tenant(request: Optional[Union[google.cloud.talent_v4.types.tenant_service.CreateTenantRequest, dict]] = None, *, parent: Optional[str] = None, tenant: Optional[google.cloud.talent_v4.types.tenant.Tenant] = 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 tenant entity.

from google.cloud import talent_v4

def sample_create_tenant():
    # Create a client
    client = talent_v4.TenantServiceClient()

    # Initialize request argument(s)
    tenant = talent_v4.Tenant()
    tenant.external_id = "external_id_value"

    request = talent_v4.CreateTenantRequest(
        parent="parent_value",
        tenant=tenant,
    )

    # Make the request
    response = client.create_tenant(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.talent_v4.types.CreateTenantRequest, dict]` 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 `parent` field on the `request` instance; if `request` is provided, this should not be set.
`tenant`	`google.cloud.talent_v4.types.Tenant` Required. The tenant to be created. This corresponds to the `tenant` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.talent_v4.types.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 jobs. Customer may create multiple tenants to provide data isolation for different groups.

delete_tenant

delete_tenant(request: Optional[Union[google.cloud.talent_v4.types.tenant_service.DeleteTenantRequest, 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 tenant.

from google.cloud import talent_v4

def sample_delete_tenant():
    # Create a client
    client = talent_v4.TenantServiceClient()

    # Initialize request argument(s)
    request = talent_v4.DeleteTenantRequest(
        name="name_value",
    )

    # Make the request
    client.delete_tenant(request=request)

Parameters
Name	Description
`request`	`Union[google.cloud.talent_v4.types.DeleteTenantRequest, dict]` 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 `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.

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_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`TenantServiceClient`	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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`TenantServiceClient`	The constructed client.

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.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_tenant

get_tenant(request: Optional[Union[google.cloud.talent_v4.types.tenant_service.GetTenantRequest, 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 tenant.

from google.cloud import talent_v4

def sample_get_tenant():
    # Create a client
    client = talent_v4.TenantServiceClient()

    # Initialize request argument(s)
    request = talent_v4.GetTenantRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_tenant(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.talent_v4.types.GetTenantRequest, dict]` 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 `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.talent_v4.types.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 jobs. Customer may create multiple tenants to provide data isolation for different groups.

list_tenants

list_tenants(request: Optional[Union[google.cloud.talent_v4.types.tenant_service.ListTenantsRequest, 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 tenants associated with the project.

from google.cloud import talent_v4

def sample_list_tenants():
    # Create a client
    client = talent_v4.TenantServiceClient()

    # Initialize request argument(s)
    request = talent_v4.ListTenantsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_tenants(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.talent_v4.types.ListTenantsRequest, dict]` 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 `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.talent_v4.services.tenant_service.pagers.ListTenantsPager`	The List tenants response object. Iterating over this object will yield results and resolve additional pages automatically.

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_tenant_path

parse_tenant_path(path: str)

Parses a tenant path into its component segments.

tenant_path

tenant_path(project: str, tenant: str)

Returns a fully-qualified tenant string.

update_tenant

update_tenant(request: Optional[Union[google.cloud.talent_v4.types.tenant_service.UpdateTenantRequest, dict]] = None, *, tenant: Optional[google.cloud.talent_v4.types.tenant.Tenant] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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 tenant.

from google.cloud import talent_v4

def sample_update_tenant():
    # Create a client
    client = talent_v4.TenantServiceClient()

    # Initialize request argument(s)
    tenant = talent_v4.Tenant()
    tenant.external_id = "external_id_value"

    request = talent_v4.UpdateTenantRequest(
        tenant=tenant,
    )

    # Make the request
    response = client.update_tenant(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.talent_v4.types.UpdateTenantRequest, dict]` The request object. Request for updating a specified tenant.
`tenant`	`google.cloud.talent_v4.types.Tenant` Required. The tenant resource to replace the current resource in the system. This corresponds to the `tenant` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` 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. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`google.cloud.talent_v4.types.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 jobs. Customer may create multiple tenants to provide data isolation for different groups.