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

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

The state of connector.

Protobuf type google.cloud.discoveryengine.v1.DataConnector.State

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ DataConnector

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

Default value.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

CREATING

Value: 1

The connector is being set up.

Generated from protobuf enum CREATING = 1;

ACTIVE

Value: 2

The connector is successfully set up and awaiting next sync run.

Generated from protobuf enum ACTIVE = 2;

FAILED

Value: 3

The connector is in error. The error details can be found in DataConnector.errors.

If the error is unfixable, the DataConnector can be deleted by CollectionService.DeleteCollection API.

Generated from protobuf enum FAILED = 3;

RUNNING

Value: 4

The connector is actively syncing records from the data source.

Generated from protobuf enum RUNNING = 4;

WARNING

Value: 5

The connector has completed a sync run, but encountered non-fatal errors.

Generated from protobuf enum WARNING = 5;

INITIALIZATION_FAILED

Value: 6

Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).

Generated from protobuf enum INITIALIZATION_FAILED = 6;

UPDATING

Value: 7

Connector is in the process of an update.

Generated from protobuf enum UPDATING = 7;