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

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

Describes the batch authorization status for a batch_authorization_group.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.BatchAuthStatus

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ placeholder string

Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector resource. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.

↳ batch_authorization_group string

Output only. The batch authorization group the placeholder belongs to.

↳ connector_auth_state ConnectorAuthState

Output only. The current authorization state for this connector.

getPlaceholder

Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector resource. E.g.

projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.

Returns
Type Description
string

setPlaceholder

Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector resource. E.g.

projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.

Parameter
Name Description
var string
Returns
Type Description
$this

getBatchAuthorizationGroup

Output only. The batch authorization group the placeholder belongs to.

Returns
Type Description
string

setBatchAuthorizationGroup

Output only. The batch authorization group the placeholder belongs to.

Parameter
Name Description
var string
Returns
Type Description
$this

getConnectorAuthState

Output only. The current authorization state for this connector.

Returns
Type Description
ConnectorAuthState|null

hasConnectorAuthState

clearConnectorAuthState

setConnectorAuthState

Output only. The current authorization state for this connector.

Parameter
Name Description
var ConnectorAuthState
Returns
Type Description
$this