Google Cloud Discovery Engine V1 Client - Class Tenant (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Tenant.

Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.

Generated from protobuf message google.cloud.discoveryengine.v1.Tenant

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ id string

The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

↳ uri string

The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.

↳ display_name string

Optional display name for the tenant, e.g. "My Slack Team".

getId

The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

Returns
Type Description
string

setId

The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

Parameter
Name Description
var string
Returns
Type Description
$this

getUri

The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.

Returns
Type Description
string

setUri

The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional display name for the tenant, e.g. "My Slack Team".

Returns
Type Description
string

setDisplayName

Optional display name for the tenant, e.g. "My Slack Team".

Parameter
Name Description
var string
Returns
Type Description
$this