Package com.veeva.vault.sdk.api.integration

Interface GetIntegrationRulesRequestBuilder

public interface GetIntegrationRulesRequestBuilder
Provides methods to build a GetIntegrationRulesRequest; built from IntegrationRuleService.newGetIntegrationRulesRequestBuilder().

  • Method Details

    • withConnectionId

      @Deprecated GetIntegrationRulesRequestBuilder withConnectionId(String connectionId)
      Deprecated.
      as of 26R1.2, replaced by withConnectionName(String) for better readability
      Sets the connection ID. Connection ID or Connection Name must be set before calling build().
      Parameters:
      connectionId - the connection ID. Cannot be null.
      Returns:
      GetIntegrationRulesRequestBuilder contract object

    • withConnectionName

      GetIntegrationRulesRequestBuilder withConnectionName(String connectionName)
      Required: Sets the connection API Name (api_name__sys). Must be set before calling build().
      Parameters:
      connectionName - the connection API name, api_name__sys. Cannot be null.
      Returns:
      GetIntegrationRulesRequestBuilder contract object

    • withIntegrationPointAPIName

      GetIntegrationRulesRequestBuilder withIntegrationPointAPIName(String integrationPointAPIName)
      Optional: Sets the integration point API Name.

      If set, this request object will be specific for integration rules tied to the connection ID and the integration point API Name. Otherwise, if omitted, the request object will be for integration rules that are tied to the connection ID only.

      Parameters:
      integrationPointAPIName - Integration Point API Name. Cannot be null.
      Returns:
      GetIntegrationRulesRequestBuilder contract object

    • build

      GetIntegrationRulesRequest build()
      Create a GetIntegrationRulesRequest based on the set parameters.

      If any required parameters are not set, this will throw an exception.

      Returns:
      a GetIntegrationRulesRequest contract object