Package org.apache.camel.builder.component.dsl

Interface ServicenowComponentBuilderFactory.ServicenowComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.servicenow.ServiceNowComponent>
All Known Implementing Classes:
ServicenowComponentBuilderFactory.ServicenowComponentBuilderImpl
Enclosing interface:
ServicenowComponentBuilderFactory
public static interface ServicenowComponentBuilderFactory.ServicenowComponentBuilder extends ComponentBuilder<org.apache.camel.component.servicenow.ServiceNowComponent>
Builder for the ServiceNow component.

  • Method Details

    • configuration

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder configuration(org.apache.camel.component.servicenow.ServiceNowConfiguration configuration)
      Component configuration. The option is a: <code>org.apache.camel.component.servicenow.ServiceNowConfiguration</code> type. Group: producer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • display

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder display(String display)
      Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. The option is a: <code>java.lang.String</code> type. Default: true Group: producer
      Parameters:
      display - the value to set
      Returns:
      the dsl builder

    • displayValue

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder displayValue(String displayValue)
      Return the display value (true), actual value (false), or both (all) for reference fields (default: false). The option is a: <code>java.lang.String</code> type. Default: false Group: producer
      Parameters:
      displayValue - the value to set
      Returns:
      the dsl builder

    • excludeReferenceLink

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder excludeReferenceLink(Boolean excludeReferenceLink)
      True to exclude Table API links for reference fields (default: false). The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      excludeReferenceLink - the value to set
      Returns:
      the dsl builder

    • favorites

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder favorites(Boolean favorites)
      Set this parameter to true to return only scorecards that are favorites of the querying user. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      favorites - the value to set
      Returns:
      the dsl builder

    • includeAggregates

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder includeAggregates(Boolean includeAggregates)
      Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAggregates - the value to set
      Returns:
      the dsl builder

    • includeAvailableAggregates

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder includeAvailableAggregates(Boolean includeAvailableAggregates)
      Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAvailableAggregates - the value to set
      Returns:
      the dsl builder

    • includeAvailableBreakdowns

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder includeAvailableBreakdowns(Boolean includeAvailableBreakdowns)
      Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAvailableBreakdowns - the value to set
      Returns:
      the dsl builder

    • includeScoreNotes

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder includeScoreNotes(Boolean includeScoreNotes)
      Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeScoreNotes - the value to set
      Returns:
      the dsl builder

    • includeScores

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder includeScores(Boolean includeScores)
      Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeScores - the value to set
      Returns:
      the dsl builder

    • inputDisplayValue

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder inputDisplayValue(Boolean inputDisplayValue)
      True to set raw value of input fields (default: false). The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      inputDisplayValue - the value to set
      Returns:
      the dsl builder

    • key

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder key(Boolean key)
      Set this parameter to true to return only scorecards for key indicators. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      key - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • models

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder models(Map<String,Class<Object>> models)
      Defines both request and response models. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: producer
      Parameters:
      models - the value to set
      Returns:
      the dsl builder

    • perPage

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder perPage(Integer perPage)
      Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100. The option is a: <code>java.lang.Integer</code> type. Default: 10 Group: producer
      Parameters:
      perPage - the value to set
      Returns:
      the dsl builder

    • release

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder release(org.apache.camel.component.servicenow.ServiceNowRelease release)
      The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com. The option is a: <code>org.apache.camel.component.servicenow.ServiceNowRelease</code> type. Default: HELSINKI Group: producer
      Parameters:
      release - the value to set
      Returns:
      the dsl builder

    • requestModels

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder requestModels(Map<String,Class<Object>> requestModels)
      Defines the request model. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: producer
      Parameters:
      requestModels - the value to set
      Returns:
      the dsl builder

    • resource

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder resource(String resource)
      The default resource, can be overridden by header CamelServiceNowResource. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      resource - the value to set
      Returns:
      the dsl builder

    • responseModels

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder responseModels(Map<String,Class<Object>> responseModels)
      Defines the response model. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Class&lt;java.lang.Object&gt;&gt;</code> type. Group: producer
      Parameters:
      responseModels - the value to set
      Returns:
      the dsl builder

    • sortBy

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder sortBy(String sortBy)
      Specify the value to use when sorting results. By default, queries sort records by value. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      sortBy - the value to set
      Returns:
      the dsl builder

    • sortDir

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder sortDir(String sortDir)
      Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      sortDir - the value to set
      Returns:
      the dsl builder

    • suppressAutoSysField

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder suppressAutoSysField(Boolean suppressAutoSysField)
      True to suppress auto generation of system fields (default: false). The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      suppressAutoSysField - the value to set
      Returns:
      the dsl builder

    • suppressPaginationHeader

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder suppressPaginationHeader(Boolean suppressPaginationHeader)
      Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      suppressPaginationHeader - the value to set
      Returns:
      the dsl builder

    • table

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder table(String table)
      The default table, can be overridden by header CamelServiceNowTable. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      table - the value to set
      Returns:
      the dsl builder

    • target

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder target(Boolean target)
      Set this parameter to true to return only scorecards that have a target. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      target - the value to set
      Returns:
      the dsl builder

    • topLevelOnly

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder topLevelOnly(Boolean topLevelOnly)
      Gets only those categories whose parent is a catalog. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      topLevelOnly - the value to set
      Returns:
      the dsl builder

    • apiVersion

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder apiVersion(String apiVersion)
      The ServiceNow REST API version, default latest. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      apiVersion - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • dateFormat

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder dateFormat(String dateFormat)
      The date format used for Json serialization/deserialization. The option is a: <code>java.lang.String</code> type. Default: yyyy-MM-dd Group: advanced
      Parameters:
      dateFormat - the value to set
      Returns:
      the dsl builder

    • dateTimeFormat

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder dateTimeFormat(String dateTimeFormat)
      The date-time format used for Json serialization/deserialization. The option is a: <code>java.lang.String</code> type. Default: yyyy-MM-dd HH:mm:ss Group: advanced
      Parameters:
      dateTimeFormat - the value to set
      Returns:
      the dsl builder

    • httpClientPolicy

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder httpClientPolicy(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)
      To configure http-client. The option is a: <code>org.apache.cxf.transports.http.configuration.HTTPClientPolicy</code> type. Group: advanced
      Parameters:
      httpClientPolicy - the value to set
      Returns:
      the dsl builder

    • instanceName

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder instanceName(String instanceName)
      The ServiceNow instance name. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      instanceName - the value to set
      Returns:
      the dsl builder

    • mapper

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder mapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
      Sets Jackson's ObjectMapper to use for request/reply. The option is a: <code>com.fasterxml.jackson.databind.ObjectMapper</code> type. Group: advanced
      Parameters:
      mapper - the value to set
      Returns:
      the dsl builder

    • proxyAuthorizationPolicy

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyAuthorizationPolicy(org.apache.cxf.configuration.security.ProxyAuthorizationPolicy proxyAuthorizationPolicy)
      To configure proxy authentication. The option is a: <code>org.apache.cxf.configuration.security.ProxyAuthorizationPolicy</code> type. Group: advanced
      Parameters:
      proxyAuthorizationPolicy - the value to set
      Returns:
      the dsl builder

    • retrieveTargetRecordOnImport

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder retrieveTargetRecordOnImport(Boolean retrieveTargetRecordOnImport)
      Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: advanced
      Parameters:
      retrieveTargetRecordOnImport - the value to set
      Returns:
      the dsl builder

    • timeFormat

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder timeFormat(String timeFormat)
      The time format used for Json serialization/deserialization. The option is a: <code>java.lang.String</code> type. Default: HH:mm:ss Group: advanced
      Parameters:
      timeFormat - the value to set
      Returns:
      the dsl builder

    • proxyHost

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyHost(String proxyHost)
      The proxy host name. The option is a: <code>java.lang.String</code> type. Group: proxy
      Parameters:
      proxyHost - the value to set
      Returns:
      the dsl builder

    • proxyPort

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyPort(Integer proxyPort)
      The proxy port number. The option is a: <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • apiUrl

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder apiUrl(String apiUrl)
      The ServiceNow REST API url. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      apiUrl - the value to set
      Returns:
      the dsl builder

    • oauthClientId

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthClientId(String oauthClientId)
      OAuth2 ClientID. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      oauthClientId - the value to set
      Returns:
      the dsl builder

    • oauthClientSecret

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthClientSecret(String oauthClientSecret)
      OAuth2 ClientSecret. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      oauthClientSecret - the value to set
      Returns:
      the dsl builder

    • oauthTokenUrl

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthTokenUrl(String oauthTokenUrl)
      OAuth token Url. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      oauthTokenUrl - the value to set
      Returns:
      the dsl builder

    • password

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder password(String password)
      ServiceNow account password, MUST be provided. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • proxyPassword

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyPassword(String proxyPassword)
      Password for proxy authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      proxyPassword - the value to set
      Returns:
      the dsl builder

    • proxyUserName

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyUserName(String proxyUserName)
      Username for proxy authentication. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      proxyUserName - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • useGlobalSslContextParameters

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder

    • userName

      default ServicenowComponentBuilderFactory.ServicenowComponentBuilder userName(String userName)
      ServiceNow user account name, MUST be provided. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      userName - the value to set
      Returns:
      the dsl builder