Class ServiceNowEndpointBuilderFactory.ServiceNowHeaderNameBuilder

  • Enclosing interface:
    ServiceNowEndpointBuilderFactory

    public static class ServiceNowEndpointBuilderFactory.ServiceNowHeaderNameBuilder
    extends Object
    The builder of headers' name for the ServiceNow component.
    • Constructor Detail

      • ServiceNowHeaderNameBuilder

        public ServiceNowHeaderNameBuilder()
    • Method Detail

      • serviceNowResource

        public String serviceNowResource()
        The resource to access. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowResource.
      • serviceNowAction

        public String serviceNowAction()
        The action to perform. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowAction.
      • serviceNowActionSubject

        public String serviceNowActionSubject()
        The action subject. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowActionSubject.
      • serviceNowModel

        public String serviceNowModel()
        The data model. The option is a: Class type. Group: producer
        Returns:
        the name of the header ServiceNowModel.
      • serviceNowRequestModel

        public String serviceNowRequestModel()
        The request data model. The option is a: Class type. Group: producer
        Returns:
        the name of the header ServiceNowRequestModel.
      • serviceNowResponseModel

        public String serviceNowResponseModel()
        The response data model. The option is a: Class type. Group: producer
        Returns:
        the name of the header ServiceNowResponseModel.
      • serviceNowContentType

        public String serviceNowContentType()
        The content type. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowContentType.
      • serviceNowContentMeta

        public String serviceNowContentMeta()
        The content meta. The option is a: Map type. Group: producer
        Returns:
        the name of the header ServiceNowContentMeta.
      • serviceNowResponseMeta

        public String serviceNowResponseMeta()
        The response meta. The option is a: Map type. Group: producer
        Returns:
        the name of the header ServiceNowResponseMeta.
      • serviceNowApiVersion

        public String serviceNowApiVersion()
        The REST API version. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowApiVersion.
      • serviceNowResponseType

        public String serviceNowResponseType()
        The type of the response. The option is a: Class type. Group: producer
        Returns:
        the name of the header ServiceNowResponseType.
      • serviceNowRetrieveTargetRecord

        public String serviceNowRetrieveTargetRecord()
        Set this parameter to true to retrieve the target record. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowRetrieveTargetRecord.
      • serviceNowTable

        public String serviceNowTable()
        The default table. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowTable.
      • serviceNowSysId

        public String serviceNowSysId()
        The sys id. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowSysId.
      • serviceNowUserSysId

        public String serviceNowUserSysId()
        The user sys id. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowUserSysId.
      • serviceNowUserId

        public String serviceNowUserId()
        The user id. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowUserId.
      • serviceNowCartItemId

        public String serviceNowCartItemId()
        The cart item id. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowCartItemId.
      • serviceNowFileName

        public String serviceNowFileName()
        The file name. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowFileName.
      • serviceNowTableSysId

        public String serviceNowTableSysId()
        The table sys id. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowTableSysId.
      • serviceNowEncryptionContext

        public String serviceNowEncryptionContext()
        The encryption context. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowEncryptionContext.
      • serviceNowCategory

        public String serviceNowCategory()
        The sys param category. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowCategory.
      • serviceNowType

        public String serviceNowType()
        The sys param type. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowType.
      • serviceNowCatalog

        public String serviceNowCatalog()
        The sys param catalog. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowCatalog.
      • serviceNowQuery

        public String serviceNowQuery()
        The sys param query. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowQuery.
      • serviceNowDisplayValue

        public String serviceNowDisplayValue()
        Return the display value (true), actual value (false), or both (all) for reference fields. The option is a: String type. Default: false Group: producer
        Returns:
        the name of the header ServiceNowDisplayValue.
      • serviceNowInputDisplayValue

        public String serviceNowInputDisplayValue()
        True to set raw value of input fields. The option is a: Boolean type. Default: false Group: producer
        Returns:
        the name of the header ServiceNowInputDisplayValue.
      • serviceNowExcludeReferenceLink

        public String serviceNowExcludeReferenceLink()
        True to exclude Table API links for reference fields. The option is a: Boolean type. Default: false Group: producer
        Returns:
        the name of the header ServiceNowExcludeReferenceLink.
      • serviceNowFields

        public String serviceNowFields()
        The sys param fields. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowFields.
      • serviceNowLimit

        public String serviceNowLimit()
        The sys param limit. The option is a: Integer type. Group: producer
        Returns:
        the name of the header ServiceNowLimit.
      • serviceNowText

        public String serviceNowText()
        The sys param text. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowText.
      • serviceNowOffset

        public String serviceNowOffset()
        The sys param offset. The option is a: Integer type. Group: producer
        Returns:
        the name of the header ServiceNowOffset.
      • serviceNowView

        public String serviceNowView()
        The sys param view. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowView.
      • serviceNowSuppressAutoSysField

        public String serviceNowSuppressAutoSysField()
        True to suppress auto generation of system fields. The option is a: Boolean type. Default: false Group: producer
        Returns:
        the name of the header ServiceNowSuppressAutoSysField.
      • serviceNowSuppressPaginationHeader

        public String serviceNowSuppressPaginationHeader()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowSuppressPaginationHeader.
      • serviceNowMinFields

        public String serviceNowMinFields()
        The sys param min fields. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowMinFields.
      • serviceNowMaxFields

        public String serviceNowMaxFields()
        The sys param max fields. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowMaxFields.
      • serviceNowSumFields

        public String serviceNowSumFields()
        The sys param sum fields. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowSumFields.
      • serviceNowAvgFields

        public String serviceNowAvgFields()
        The sys param avg fields. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowAvgFields.
      • serviceNowCount

        public String serviceNowCount()
        The sys param count. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowCount.
      • serviceNowGroupBy

        public String serviceNowGroupBy()
        The sys param group by. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowGroupBy.
      • serviceNowOrderBy

        public String serviceNowOrderBy()
        The sys param order by. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowOrderBy.
      • serviceNowHaving

        public String serviceNowHaving()
        The sys param having. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowHaving.
      • serviceNowUUID

        public String serviceNowUUID()
        The sys param UUID. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowUUID.
      • serviceNowBreakdown

        public String serviceNowBreakdown()
        The sys param breakdown. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowBreakdown.
      • serviceNowIncludeScores

        public String serviceNowIncludeScores()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowIncludeScores.
      • serviceNowIncludeScoreNotes

        public String serviceNowIncludeScoreNotes()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowIncludeScoreNotes.
      • serviceNowIncludeAggregates

        public String serviceNowIncludeAggregates()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowIncludeAggregates.
      • serviceNowIncludeAvailableBreakdowns

        public String serviceNowIncludeAvailableBreakdowns()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowIncludeAvailableBreakdowns.
      • serviceNowIncludeAvailableAggregates

        public String serviceNowIncludeAvailableAggregates()
        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: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowIncludeAvailableAggregates.
      • serviceNowFavorites

        public String serviceNowFavorites()
        Set this parameter to true to return only scorecards that are favorites of the querying user. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowFavorites.
      • serviceNowKey

        public String serviceNowKey()
        Set this parameter to true to return only scorecards for key indicators. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowKey.
      • serviceNowTarget

        public String serviceNowTarget()
        Set this parameter to true to return only scorecards that have a target. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowTarget.
      • serviceNowDisplay

        public String serviceNowDisplay()
        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. The option is a: String type. Default: true Group: producer
        Returns:
        the name of the header ServiceNowDisplay.
      • serviceNowPerPage

        public String serviceNowPerPage()
        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: Integer type. Default: 10 Group: producer
        Returns:
        the name of the header ServiceNowPerPage.
      • serviceNowSortBy

        public String serviceNowSortBy()
        Specify the value to use when sorting results. By default, queries sort records by value. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowSortBy.
      • serviceNowSortDir

        public String serviceNowSortDir()
        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: String type. Group: producer
        Returns:
        the name of the header ServiceNowSortDir.
      • serviceNowContains

        public String serviceNowContains()
        The sys param contains. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowContains.
      • serviceNowTags

        public String serviceNowTags()
        The sys param tags. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowTags.
      • serviceNowPage

        public String serviceNowPage()
        The sys param page. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowPage.
      • serviceNowElementsFilter

        public String serviceNowElementsFilter()
        The sys param elements filter. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowElementsFilter.
      • serviceNowBreakdownRelation

        public String serviceNowBreakdownRelation()
        The sys param breakdown relation. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowBreakdownRelation.
      • serviceNowDataSource

        public String serviceNowDataSource()
        The sys param data source. The option is a: String type. Group: producer
        Returns:
        the name of the header ServiceNowDataSource.
      • serviceNowTopLevelOnly

        public String serviceNowTopLevelOnly()
        Gets only those categories whose parent is a catalog. The option is a: Boolean type. Group: producer
        Returns:
        the name of the header ServiceNowTopLevelOnly.