Package org.apache.camel.builder.endpoint.dsl

Interface ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
ServiceNowEndpointBuilderFactory
public static interface ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the ServiceNow component.

  • Method Details

    • advanced

      default ServiceNowEndpointBuilderFactory.AdvancedServiceNowEndpointBuilder advanced()

    • display

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • excludeReferenceLink

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

    • favorites

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • favorites

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

    • includeAggregates

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • includeAggregates

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder includeAggregates(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAggregates - the value to set
      Returns:
      the dsl builder

    • includeAvailableAggregates

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • includeAvailableAggregates

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder includeAvailableAggregates(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAvailableAggregates - the value to set
      Returns:
      the dsl builder

    • includeAvailableBreakdowns

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • includeAvailableBreakdowns

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder includeAvailableBreakdowns(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeAvailableBreakdowns - the value to set
      Returns:
      the dsl builder

    • includeScoreNotes

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • includeScoreNotes

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder includeScoreNotes(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeScoreNotes - the value to set
      Returns:
      the dsl builder

    • includeScores

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • includeScores

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder includeScores(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      includeScores - the value to set
      Returns:
      the dsl builder

    • inputDisplayValue

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • inputDisplayValue

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder inputDisplayValue(String inputDisplayValue)
      True to set raw value of input fields (default: false). The option will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      inputDisplayValue - the value to set
      Returns:
      the dsl builder

    • key

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • key

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

    • models

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder models(String key, Object value)
      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. The option is multivalued, and you can use the models(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • models

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder models(Map values)
      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. The option is multivalued, and you can use the models(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • perPage

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • perPage

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

    • release

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • release

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder release(String release)
      The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com. The option will be converted to 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder requestModels(String key, Object value)
      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. The option is multivalued, and you can use the requestModels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • requestModels

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder requestModels(Map values)
      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. The option is multivalued, and you can use the requestModels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • resource

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder responseModels(String key, Object value)
      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. The option is multivalued, and you can use the responseModels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • responseModels

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder responseModels(Map values)
      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. The option is multivalued, and you can use the responseModels(String, Object) method to add a value (call the method multiple times to set more values). Group: producer
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • sortBy

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • suppressAutoSysField

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

    • suppressPaginationHeader

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • suppressPaginationHeader

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder suppressPaginationHeader(String 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 will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      suppressPaginationHeader - the value to set
      Returns:
      the dsl builder

    • table

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • target

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

    • topLevelOnly

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • topLevelOnly

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

    • proxyHost

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • proxyPort

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder proxyPort(String proxyPort)
      The proxy port number. The option will be converted to a <code>java.lang.Integer</code> type. Group: proxy
      Parameters:
      proxyPort - the value to set
      Returns:
      the dsl builder

    • apiUrl

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder password(String password)
      ServiceNow account password, MUST be provided. The option is a: <code>java.lang.String</code> type. Required: true Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • proxyPassword

      default ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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 ServiceNowEndpointBuilderFactory.ServiceNowEndpointBuilder 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

    • sslContextParameters

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

    • userName

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