Package com.snowflake.connectors.application.ingestion.enable

Class EnableResourceHandler

java.lang.Object

com.snowflake.connectors.application.ingestion.enable.EnableResourceHandler

public class EnableResourceHandler
extends Object

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

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

Method Summary

Modifier and Type	Method	Description
static EnableResourceHandlerBuilder	builder(Session session)	Returns a new instance of EnableResourceHandlerBuilder.
static Variant	enableResource(Session session, String resourceIngestionDefinitionId)	Default handler method for the PUBLIC.ENABLE_RESOURCE procedure.
ConnectorResponse	enableResource(String resourceIngestionDefinitionId)	Enables 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

enableResource

public static Variant enableResource(Session session,
                                     String resourceIngestionDefinitionId)

Default handler method for the PUBLIC.ENABLE_RESOURCE procedure.

Parameters:

session - Snowpark session object

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

Returns:

a variant representing the ConnectorResponse returned by enableResource(String)

enableResource

public ConnectorResponse enableResource(String resourceIngestionDefinitionId)

Enables a resource with given id.

The process of enabling a resource consists of:

• EnableResourceValidator.validate(java.lang.String)
• PreEnableResourceCallback.execute(java.lang.String)
• changing 'enabled' flag of the resource ingestion definition to true
• creating a new IngestionProcess for each ingestion configuration of given resource ingestion definition
• PostEnableResourceCallback.execute(java.lang.String)

If a resource is already enabled, nothing is done. If a resource ingestion definition with a 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 EnableResourceHandlerBuilder builder(Session session)

Returns a new instance of EnableResourceHandlerBuilder.

Parameters:

session - Snowpark session object

Returns:

a new builder instance