Package com.snowflake.connectors.application.ingestion.disable

Class DisableResourceHandler

java.lang.Object

com.snowflake.connectors.application.ingestion.disable.DisableResourceHandler

public class DisableResourceHandler
extends Object

Handler for the process of disabling a resource. A new instance of the handler must be created using the builder.

For more information about the disabling process see disableResource(String).

Method Summary

Modifier and Type	Method	Description
static DisableResourceHandlerBuilder	builder(Session session)	Returns a new instance of DisableResourceHandlerBuilder.
static Variant	disableResource(Session session, String resourceIngestionDefinitionId)	Default handler method for the PUBLIC.DISABLE_RESOURCE procedure.
ConnectorResponse	disableResource(String resourceIngestionDefinitionId)	Disables a resource with given id

Methods inherited from class java.lang.Object

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

Method Detail

disableResource

public static Variant disableResource(Session session,
                                      String resourceIngestionDefinitionId)

Default handler method for the PUBLIC.DISABLE_RESOURCE procedure.

Parameters:

session - Snowpark session object

resourceIngestionDefinitionId - id of a resource ingestion definition which should be disabled

Returns:

a variant representing the ConnectorResponse

disableResource

public ConnectorResponse disableResource(String resourceIngestionDefinitionId)

Disables a resource with given id

The process of disabling a resource consists of:

• calling PreDisableResourceCallback
• changing 'enabled' flag of the resource ingestion definition to false
• ending all active ingestion processes associated with the resource ingestion definition
• calling PostDisableResourceCallback

If a resource is already disabled, nothing is done. If a resource ingestion definition with given id does not exist, InvalidInputException is thrown.

Parameters:

resourceIngestionDefinitionId - id of resource ingestion definition

Returns:

a response with the code OK if the execution was successful, otherwise a response with an error code and an error message

builder

public static DisableResourceHandlerBuilder builder(Session session)

Returns a new instance of DisableResourceHandlerBuilder.

Parameters:

session - Snowpark session object

Returns:

a new builder instance