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

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

The authorization state of the data connector.

Protobuf type google.cloud.discoveryengine.v1.WidgetConfig.ConnectorAuthState.AuthState

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig \ ConnectorAuthState

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

AUTH_STATE_UNSPECIFIED

Value: 0

Default value. Also returned for synthetic placeholder CollectionComponent entries surfaced by LookupWidgetConfig with view = WITH_AVAILABLE_CONNECTORS (SaaS / Business only) — those entries represent connectors the caller may attach but has not yet attached.

Generated from protobuf enum AUTH_STATE_UNSPECIFIED = 0;

AUTHORIZED

Value: 1

The user has authorized the data connector.

Generated from protobuf enum AUTHORIZED = 1;

EXPIRED

Value: 2

The user authorization for the data connector has expired.

Generated from protobuf enum EXPIRED = 2;

ACTIONS_DISABLED

Value: 3

The user can still make search requests but actions need to be enabled.

Generated from protobuf enum ACTIONS_DISABLED = 3;

NO_AUTH

Value: 4

The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth.

Generated from protobuf enum NO_AUTH = 4;