Package com.snowflake.connectors.application.lifecycle.pause

Class PauseConnectorHandler

java.lang.Object

com.snowflake.connectors.application.lifecycle.pause.PauseConnectorHandler

public class PauseConnectorHandler
extends Object

Handler for the connector pausing process. A new instance of the handler must be created using the builder.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERROR_TYPE	Error type for the connector pausing failure, used by the ConnectorErrorHelper.

Method Summary

Modifier and Type	Method	Description
static PauseConnectorHandlerBuilder	builder(Session session)	Returns a new instance of PauseConnectorHandlerBuilder.
ConnectorResponse	pauseConnector()	Executes the main logic of the handler, with logging using withExceptionLogging.
static Variant	pauseConnector(Session session)	Default handler method for the PUBLIC.PAUSE_CONNECTOR procedure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_TYPE

public static final String ERROR_TYPE

Error type for the connector pausing failure, used by the ConnectorErrorHelper.

See Also:

Constant Field Values

Method Detail

pauseConnector

public static Variant pauseConnector(Session session)

Default handler method for the PUBLIC.PAUSE_CONNECTOR procedure.

Parameters:

session - Snowpark session object

Returns:

a variant representing the ConnectorResponse returned by pauseConnector

builder

public static PauseConnectorHandlerBuilder builder(Session session)

Returns a new instance of PauseConnectorHandlerBuilder.

Parameters:

session - Snowpark session object

Returns:

a new builder instance

pauseConnector

public ConnectorResponse pauseConnector()

Executes the main logic of the handler, with logging using withExceptionLogging.

The handler logic consists of:

• connector privileges check
• connector status check
• PauseConnectorStateValidator.validate()
• PauseConnectorCallback.execute()
• PauseConnectorSdkCallback.execute()
• PauseTaskReactorService.pauseAllInstances()
• connector status update

If the callback execution returns a ROLLBACK code, any changes made by this handler are also rolled back.

Returns:

a response with the code OK if the execution was successful, a response with the code ROLLBACK if a rollback operation was performed, or a response with an error code and an error message