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

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

Read-only connector in CollectionComponent auth state.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ auth_state int

Output only. The authorization state of the data connector.

↳ authorization_uri string

Output only. The authorization uri for the data connector. For synthetic placeholder CollectionComponent entries (returned by LookupWidgetConfig with view = WITH_AVAILABLE_CONNECTORS on SaaS / Business engines), this field is left empty. The widget should call WidgetService.WidgetBuildAuthorizationUrl on the user's "Connect" click to obtain a freshly-built authorization URL.

↳ update_time Google\Protobuf\Timestamp

Output only. The authorization state update timestamp.

getAuthState

Output only. The authorization state of the data connector.

Returns
Type Description
int Enum of type AuthState.

setAuthState

Output only. The authorization state of the data connector.

Parameter
Name Description
var int

Enum of type AuthState.

Returns
Type Description
$this

getAuthorizationUri

Output only. The authorization uri for the data connector.

For synthetic placeholder CollectionComponent entries (returned by LookupWidgetConfig with view = WITH_AVAILABLE_CONNECTORS on SaaS / Business engines), this field is left empty. The widget should call WidgetService.WidgetBuildAuthorizationUrl on the user's "Connect" click to obtain a freshly-built authorization URL.

Returns
Type Description
string

setAuthorizationUri

Output only. The authorization uri for the data connector.

For synthetic placeholder CollectionComponent entries (returned by LookupWidgetConfig with view = WITH_AVAILABLE_CONNECTORS on SaaS / Business engines), this field is left empty. The widget should call WidgetService.WidgetBuildAuthorizationUrl on the user's "Connect" click to obtain a freshly-built authorization URL.

Parameter
Name Description
var string
Returns
Type Description
$this

getUpdateTime

Output only. The authorization state update timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The authorization state update timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this