ServicenowComponentBuilderFactory.ServicenowComponentBuilder (Camel

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 Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`apiUrl(String apiUrl)` The ServiceNow REST API url.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`apiVersion(String apiVersion)` The ServiceNow REST API version, default latest.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`configuration(org.apache.camel.component.servicenow.ServiceNowConfiguration configuration)` Component configuration.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`dateFormat(String dateFormat)` The date format used for Json serialization/deserialization.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`dateTimeFormat(String dateTimeFormat)` The date-time format used for Json serialization/deserialization.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`display(String display)` Set this parameter to true to return only scorecards where the indicator Display field is selected.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`displayValue(String displayValue)` Return the display value (true), actual value (false), or both (all) for reference fields (default: false).
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`excludeReferenceLink(Boolean excludeReferenceLink)` True to exclude Table API links for reference fields (default: false).
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`favorites(Boolean favorites)` Set this parameter to true to return only scorecards that are favorites of the querying user.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`httpClientPolicy(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)` To configure http-client.
`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.
`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.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`includeAvailableBreakdowns(Boolean includeAvailableBreakdowns)` Set this parameter to true to return all available breakdowns for an indicator.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`includeScoreNotes(Boolean includeScoreNotes)` Set this parameter to true to return all notes associated with the score.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`includeScores(Boolean includeScores)` Set this parameter to true to return all scores for a scorecard.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`inputDisplayValue(Boolean inputDisplayValue)` True to set raw value of input fields (default: false).
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`instanceName(String instanceName)` The ServiceNow instance name.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`key(Boolean key)` Set this parameter to true to return only scorecards for key indicators.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`mapper(com.fasterxml.jackson.databind.ObjectMapper mapper)` Sets Jackson's ObjectMapper to use for request/reply.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`models(Map<String,Class<Object>> models)` Defines both request and response models.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`oauthClientId(String oauthClientId)` OAuth2 ClientID.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`oauthClientSecret(String oauthClientSecret)` OAuth2 ClientSecret.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`oauthTokenUrl(String oauthTokenUrl)` OAuth token Url.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`password(String password)` ServiceNow account password, MUST be provided.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`perPage(Integer perPage)` Enter the maximum number of scorecards each query can return.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`proxyAuthorizationPolicy(org.apache.cxf.configuration.security.ProxyAuthorizationPolicy proxyAuthorizationPolicy)` To configure proxy authentication.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`proxyHost(String proxyHost)` The proxy host name.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`proxyPassword(String proxyPassword)` Password for proxy authentication.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`proxyPort(Integer proxyPort)` The proxy port number.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`proxyUserName(String proxyUserName)` Username for proxy authentication.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`release(org.apache.camel.component.servicenow.ServiceNowRelease release)` The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`requestModels(Map<String,Class<Object>> requestModels)` Defines the request model.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`resource(String resource)` The default resource, can be overridden by header CamelServiceNowResource.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`responseModels(Map<String,Class<Object>> responseModels)` Defines the response model.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`retrieveTargetRecordOnImport(Boolean retrieveTargetRecordOnImport)` Set this parameter to true to retrieve the target record when using import set api.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`sortBy(String sortBy)` Specify the value to use when sorting results.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`sortDir(String sortDir)` Specify the sort direction, ascending or descending.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`suppressAutoSysField(Boolean suppressAutoSysField)` True to suppress auto generation of system fields (default: false).
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`suppressPaginationHeader(Boolean suppressPaginationHeader)` Set this value to true to remove the Link header from the response.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`table(String table)` The default table, can be overridden by header CamelServiceNowTable.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`target(Boolean target)` Set this parameter to true to return only scorecards that have a target.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`timeFormat(String timeFormat)` The time format used for Json serialization/deserialization.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`topLevelOnly(Boolean topLevelOnly)` Gets only those categories whose parent is a catalog.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`useGlobalSslContextParameters(boolean useGlobalSslContextParameters)` Enable usage of global SSL context parameters.
`default ServicenowComponentBuilderFactory.ServicenowComponentBuilder`	`userName(String userName)` ServiceNow user account name, MUST be provided.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - configuration
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder configuration(org.apache.camel.component.servicenow.ServiceNowConfiguration configuration)
```
    Component configuration. The option is a: org.apache.camel.component.servicenow.ServiceNowConfiguration type. Group: producer
  - 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: java.lang.String type. Default: true Group: producer
  - 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: java.lang.String type. Default: false Group: producer
  - excludeReferenceLink
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder excludeReferenceLink(Boolean excludeReferenceLink)
```
    True to exclude Table API links for reference fields (default: false). The option is a: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - inputDisplayValue
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder inputDisplayValue(Boolean inputDisplayValue)
```
    True to set raw value of input fields (default: false). The option is a: java.lang.Boolean type. Group: producer
  - key
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder key(Boolean key)
```
    Set this parameter to true to return only scorecards for key indicators. The option is a: java.lang.Boolean type. Group: producer
  - 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: boolean type. Default: false Group: producer
  - models
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder models(Map<String,Class<Object>> models)
```
    Defines both request and response models. The option is a: java.util.Map> type. Group: producer
  - 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: java.lang.Integer type. Default: 10 Group: producer
  - 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: org.apache.camel.component.servicenow.ServiceNowRelease type. Default: HELSINKI Group: producer
  - requestModels
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder requestModels(Map<String,Class<Object>> requestModels)
```
    Defines the request model. The option is a: java.util.Map> type. Group: producer
  - resource
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder resource(String resource)
```
    The default resource, can be overridden by header CamelServiceNowResource. The option is a: java.lang.String type. Group: producer
  - responseModels
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder responseModels(Map<String,Class<Object>> responseModels)
```
    Defines the response model. The option is a: java.util.Map> type. Group: producer
  - 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: java.lang.String type. Group: producer
  - 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: java.lang.String type. Group: producer
  - suppressAutoSysField
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder suppressAutoSysField(Boolean suppressAutoSysField)
```
    True to suppress auto generation of system fields (default: false). The option is a: java.lang.Boolean type. Group: producer
  - 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: java.lang.Boolean type. Group: producer
  - table
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder table(String table)
```
    The default table, can be overridden by header CamelServiceNowTable. The option is a: java.lang.String type. Group: producer
  - target
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder target(Boolean target)
```
    Set this parameter to true to return only scorecards that have a target. The option is a: java.lang.Boolean type. Group: producer
  - topLevelOnly
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder topLevelOnly(Boolean topLevelOnly)
```
    Gets only those categories whose parent is a catalog. The option is a: java.lang.Boolean type. Group: producer
  - apiVersion
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder apiVersion(String apiVersion)
```
    The ServiceNow REST API version, default latest. The option is a: java.lang.String type. Group: advanced
  - basicPropertyBinding
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - dateFormat
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder dateFormat(String dateFormat)
```
    The date format used for Json serialization/deserialization. The option is a: java.lang.String type. Default: yyyy-MM-dd Group: advanced
  - dateTimeFormat
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder dateTimeFormat(String dateTimeFormat)
```
    The date-time format used for Json serialization/deserialization. The option is a: java.lang.String type. Default: yyyy-MM-dd HH:mm:ss Group: advanced
  - httpClientPolicy
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder httpClientPolicy(org.apache.cxf.transports.http.configuration.HTTPClientPolicy httpClientPolicy)
```
    To configure http-client. The option is a: org.apache.cxf.transports.http.configuration.HTTPClientPolicy type. Group: advanced
  - instanceName
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder instanceName(String instanceName)
```
    The ServiceNow instance name. The option is a: java.lang.String type. Group: advanced
  - mapper
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder mapper(com.fasterxml.jackson.databind.ObjectMapper mapper)
```
    Sets Jackson's ObjectMapper to use for request/reply. The option is a: com.fasterxml.jackson.databind.ObjectMapper type. Group: advanced
  - proxyAuthorizationPolicy
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyAuthorizationPolicy(org.apache.cxf.configuration.security.ProxyAuthorizationPolicy proxyAuthorizationPolicy)
```
    To configure proxy authentication. The option is a: org.apache.cxf.configuration.security.ProxyAuthorizationPolicy type. Group: advanced
  - 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: java.lang.Boolean type. Default: false Group: advanced
  - timeFormat
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder timeFormat(String timeFormat)
```
    The time format used for Json serialization/deserialization. The option is a: java.lang.String type. Default: HH:mm:ss Group: advanced
  - proxyHost
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyHost(String proxyHost)
```
    The proxy host name. The option is a: java.lang.String type. Group: proxy
  - proxyPort
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyPort(Integer proxyPort)
```
    The proxy port number. The option is a: java.lang.Integer type. Group: proxy
  - apiUrl
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder apiUrl(String apiUrl)
```
    The ServiceNow REST API url. The option is a: java.lang.String type. Group: security
  - oauthClientId
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthClientId(String oauthClientId)
```
    OAuth2 ClientID. The option is a: java.lang.String type. Group: security
  - oauthClientSecret
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthClientSecret(String oauthClientSecret)
```
    OAuth2 ClientSecret. The option is a: java.lang.String type. Group: security
  - oauthTokenUrl
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder oauthTokenUrl(String oauthTokenUrl)
```
    OAuth token Url. The option is a: java.lang.String type. Group: security
  - password
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder password(String password)
```
    ServiceNow account password, MUST be provided. The option is a: java.lang.String type. Group: security
  - proxyPassword
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyPassword(String proxyPassword)
```
    Password for proxy authentication. The option is a: java.lang.String type. Group: security
  - proxyUserName
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder proxyUserName(String proxyUserName)
```
    Username for proxy authentication. The option is a: java.lang.String type. Group: security
  - 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: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
  - useGlobalSslContextParameters
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
```
    Enable usage of global SSL context parameters. The option is a: boolean type. Default: false Group: security
  - userName
```
default ServicenowComponentBuilderFactory.ServicenowComponentBuilder userName(String userName)
```
    ServiceNow user account name, MUST be provided. The option is a: java.lang.String type. Group: security

Interface ServicenowComponentBuilderFactory.ServicenowComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

configuration

display

displayValue

excludeReferenceLink

favorites

includeAggregates

includeAvailableAggregates

includeAvailableBreakdowns

includeScoreNotes

includeScores

inputDisplayValue

key

lazyStartProducer

models

perPage

release

requestModels

resource

responseModels

sortBy

sortDir

suppressAutoSysField

suppressPaginationHeader

table

target

topLevelOnly

apiVersion

basicPropertyBinding

dateFormat

dateTimeFormat

httpClientPolicy

instanceName

mapper

proxyAuthorizationPolicy

retrieveTargetRecordOnImport

timeFormat

proxyHost

proxyPort

apiUrl

oauthClientId

oauthClientSecret

oauthTokenUrl

password

proxyPassword

proxyUserName

sslContextParameters

useGlobalSslContextParameters

userName