Google Cloud Eventarc V1 Client - Class State (2.0.0-RC1)

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

State lists all the possible states of a Channel

Protobuf type google.cloud.eventarc.v1.Channel.State

Namespace

Google \ Cloud \ Eventarc \ V1 \ Channel

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

Default value. This value is unused.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

PENDING

Value: 1

The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.

Generated from protobuf enum PENDING = 1;

ACTIVE

Value: 2

The ACTIVE state indicates that a Channel has been successfully connected with the event provider.

An ACTIVE Channel is ready to receive and route events from the event provider.

Generated from protobuf enum ACTIVE = 2;

INACTIVE

Value: 3

The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen:

  1. The SaaS provider disconnected from this Channel.

  2. The Channel activation token has expired but the SaaS provider wasn't connected. To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider.

Generated from protobuf enum INACTIVE = 3;