Git Integration for Jira Self-Managed (Data Center/Server) Documentation

Contact Support: Server  
Contact Support: Data Center  

Class IntegrationRequest

This is a POJO object containing an integration properties/settings.

Summary

Constructors

Visibility Signature
public IntegrationRequest()
public IntegrationRequest(IntegrationType type, String origin, String pat, String displayName)

Methods

Type and modifiers Method signature
public String getApiFilter()
public String getApiPath()
public String getAwsRegion()
public Boolean getDisableSslVerification()
public Boolean getDisabled()
public String getDisplayName()
public Integer getFolderDepth()
public Boolean getGitViewerEnabled()
public Boolean getGlobal()
public Integer getMaxMinsToCommitEmail()
public String getOrigin()
public String getPassword()
public String getPat()
public Set < Long > getProjectMappingIds()
public Boolean getRefSpecChanges()
public String getRefSpecCustom()
public Boolean getRefSpecNotes()
public Boolean getRequireUserPat()
public Boolean getRevisionIndexing()
public Boolean getSendCommitEmails()
public Boolean getSmartCommitsEnabled()
public Boolean getSourcesDiffViewEnabled()
public String getTagsFilter()
public String getTfsCollection()
public Boolean getTrustFolderStat()
public String getType()
public String getUsername()
public void initPassword( String password)
public void initPat( String pat)
public void setApiFilter( String apiFilter)
public void setApiPath( String apiPath)
public void setAwsRegion( String awsRegion)
public void setDisableSslVerification( Boolean disableSslVerification)
public void setDisabled( Boolean disabled)
public void setDisplayName( String displayName)
public void setFolderDepth( Integer folderDepth)
public void setGitViewerEnabled( Boolean gitViewerEnabled)
public void setGlobal( Boolean global)
public void setMaxMinsToCommitEmail( Integer maxMinsToCommitEmail)
public void setOrigin( String origin)
public void setPassword( String password)
public void setPat( String pat)
public void setProjectMappingIds( Set < Long > projectMappingIds)
public void setRefSpecChanges( Boolean refSpecChanges)
public void setRefSpecCustom( String refSpecCustom)
public void setRefSpecNotes( Boolean refSpecNotes)
public void setRequireUserPat( Boolean requireUserPat)
public void setRevisionIndexing( Boolean revisionIndexing)
public void setSendCommitEmails( Boolean sendCommitEmails)
public void setSmartCommitsEnabled( Boolean smartCommitsEnabled)
public void setSourcesDiffViewEnabled( Boolean sourcesDiffViewEnabled)
public void setTagsFilter( String tagsFilter)
public void setTfsCollection( String tfsCollection)
public void setTrustFolderStat( Boolean trustFolderStat)
public void setType( String type)
public void setUsername( String username)

Constructors

IntegrationRequest()

IntegrationRequest(IntegrationType, String, String, String)

Methods

getApiFilter()

Returns JMESPath Filter property of the Integration.

getApiPath()

Returns Custom API Path property of the Integration.

getAwsRegion()

Returns AWS region property. It is used for AWS integrations only.

getDisableSslVerification()

Returns SSL Verify setting.

getDisabled()

Returns whether the Integration is disabled.

getDisplayName()

Returns the Display Name of the Integration.

getFolderDepth()

Returns Folder Depth property. Is used for tracked folders only.

getGitViewerEnabled()

Returns whether Repository Browser feature is enabled.

For more information, see section, Repository Browser.

getGlobal()

Returns whether the integration repositories are visible for all projects.

getMaxMinsToCommitEmail()

Returns the property "Max commit age in minutes" value.

getOrigin()

Returns the Origin of the Integration.

getPassword()

Returns password encrypted.

getPat()

Returns PAT encrypted.

getProjectMappingIds()

Returns numeric projects IDs associated with the repository.

getRefSpecChanges()

getRefSpecCustom()

getRefSpecNotes()

getRequireUserPat()

Returns value of Require User PAT property.

getRevisionIndexing()

getSendCommitEmails()

Returns the property "Send email notifications" value.

getSmartCommitsEnabled()

Returns whether smart commits processing for the integration repositories is enabled.

getSourcesDiffViewEnabled()

getTagsFilter()

getTfsCollection()

Returns TFS Collection property. It is used for Microsoft integrations only.

getTrustFolderStat()

getType()

Returns type of the Integration.

getUsername()

Returns username for the git host.

initPassword(String)

Sets password as is. Use the method when none encryption is required.

GIJFacade requires an IntegrationRequest with an encrypted password, so use setPassword() instead of initPassword().

Parameters

  • password: password

initPat(String)

Sets PAT as is. Use the method when none encryption is required.
br>
GIJFacade requires an IntegrationRequest with an encrypted PAT, so use setPat() instead of initPat().

Parameters

  • pat:

setApiFilter(String)

Sets JMESPath Filter property.
It is a JMESPath filter expression. The expression will be used to filter API results such as repository names, etc.
For more information, see article Working with JMESPath filters.

GIJFacade.createIntegration(): Optional.

GIJFacade.updateIntegration(): Optional.

Parameters

  • apiFilter: new JMESPath Filter

setApiPath(String)

Sets Custom API Path property. The integration will use the relative REST API path starting with "/"
to retrieve the list of tracked repositories.
For more information, see Working with Custom API path

GIJFacade.createIntegration(): Optional.

GIJFacade.updateIntegration(): Optional.

Parameters

  • apiPath:

setAwsRegion(String)

Sets AWS region; where CodeCommit repositories are located.
The list of regions with their names can be found here.

Supported regions:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ap-south-1
  • ap-northeast-2
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1
  • ca-central-1
  • eu-central-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-north-1
  • me-south-1
  • sa-east-1

    GIJFacade.createIntegration(): Optional. Required for AWS Integration creation.

    GIJFacade.updateIntegration(): Optional.

Parameters

  • awsRegion:

setDisableSslVerification(Boolean)

Sets SSL Verify setting.

The SSL Verify setting is set to Enabled by default. If set to disabled, the Git Integration for Jira app will
ignore verification of SSL certificates when connecting to a git server.

GIJFacade.createIntegration(): Optional. The default value for this setting is false.

GIJFacade.updateIntegration(): Optional.

Parameters

  • disableSslVerification:

setDisabled(Boolean)

Sets the disabled flag for the Integration.

Set the repository status to updated (enabled) or disabled. If left blank, the default setting for this field is false.

GIJFacade.createIntegration(): Optional. The default value is false

GIJFacade.updateIntegration(): Optional.

Parameters

  • disabled: the new value of ‘disabled’ flag

setDisplayName(String)

Sets the Display Name of the Integration.
This is the name that will appear in the Git Integration for Jira app repositories list.

GIJFacade.createIntegration(): Optional. Is autogenerated by default.

GIJFacade.updateIntegration(): Optional.

Parameters

  • displayName: the new display name

setFolderDepth(Integer)

Sets Folder Depth property. Is used for tracked folders only.

GIJFacade.createIntegration(): Optional. The default value is 1.

GIJFacade.updateIntegration(): Optional.

Parameters

  • folderDepth:

setGitViewerEnabled(Boolean)

Enables or disables Repository Browser feature.

GIJFacade.createIntegration(): Optional. Is true by default.

GIJFacade.updateIntegration(): Optional.

Parameters

  • gitViewerEnabled: new value for "Repository Browser" parameter

setGlobal(Boolean)

If set to true, the projectMappingIds parameter is ignored. Otherwise, the projectMappingIds parameter value(s) are applied.

Parameters

  • global: new value for "Associate with all projects" property

setMaxMinsToCommitEmail(Integer)

Sets the property "Max commit age in minutes" for the Integration. Email notification for commits

GIJFacade.createIntegration(): Optional. The default value is 1440 minutes.

GIJFacade.updateIntegration(): Optional.

Parameters

  • maxMinsToCommitEmail: the new value of ‘Max commit age in minutes’ property

setOrigin(String)

Sets the Origin of the Integration.
This is the URL to the hosted git service used on the project.

For example, you might host your repository on GitHub, Beanstalk or your own server.

GIJFacade.createIntegration(): Required.

GIJFacade.updateIntegration(): Optional.

Parameters

  • origin: the new origin.

setPassword(String)

Sets new password for the git host. Leave blank and use PAT if 2FA is enabled on the git server.

The IN password will be encrypted.
Use initPassword() when none encryption is required.

GIJFacade requires an IntegrationRequest with an encrypted password, so use setPassword() instead of initPassword().

Parameters

  • password: new password

setPat(String)

Sets the PAT (personal access token) to be used to connect the Integration. The IN PAT will be encrypted.
Use initPat() when none encryption is required.

GIJFacade requires an IntegrationRequest with an encrypted PAT, so use setPat() instead of initPat().

Parameters

  • pat: pat

setProjectMappingIds(Set)

Sets numeric projects IDs associated with the repository.

This field accepts list of comma separated project IDs for project mapping. Trailing spaces are ignored
(equivalent to unchecking the Associate to All Projects checkbox in the Advanced Setup dialog).

Example: “projectMappingIds”: [10000,10100]

GIJFacade.createIntegration(): Optional.

GIJFacade.updateIntegration(): Optional.

Parameters

  • projectMappingIds: new list of projects associated with the repository

setRefSpecChanges(Boolean)

setRefSpecCustom(String)

setRefSpecNotes(Boolean)

setRequireUserPat(Boolean)

Setting this parameter to true will require users to specify their own PAT for branch and pull/merge request management.

GIJFacade.createIntegration(): Optional. Is false by default.

GIJFacade.updateIntegration(): Optional.

Parameters

  • requireUserPat: new value for "Require User PAT" parameter

setRevisionIndexing(Boolean)

setSendCommitEmails(Boolean)

Sets the property "Send email notifications" for the Integration.

GIJFacade.createIntegration(): Optional. The default value is false???

GIJFacade.updateIntegration(): Optional.

Parameters

  • sendCommitEmails: the new value of ‘Send email notifications’ property

setSmartCommitsEnabled(Boolean)

Enables or disables smart commits processing.

GIJFacade.createIntegration(): Optional. Is true by default.

GIJFacade.updateIntegration(): Optional.

Parameters

  • smartCommitsEnabled: new value for "Smart Commits" parameter

setSourcesDiffViewEnabled(Boolean)

setTagsFilter(String)

setTfsCollection(String)

Sets TFS Collection property. It is used for Microsoft integrations only.

GIJFacade.createIntegration(): Optional.

GIJFacade.updateIntegration(): Optional.

Parameters

  • tfsCollection: new collection

setTrustFolderStat(Boolean)

setType(String)

Sets type of the Integration. Available values are the following:

  • GITHUB – integration with Github.com
  • GITHUB_SERVER – integration with GitHub Enterprise
  • GITLAB – integration with GitLab.com
  • GITLAB_SERVER – integration with GitLab Server (CE/EE) (APIv4)
  • GITLAB_SERVER_LEGACY – integration with GitLab Server (CE/EE) Legacy (APIv3)
  • FILESPACE – integration for a tracked folder
  • AZURE_DEVOPS – integration with Azure DevOps Repos
  • VSTS – integration with Visual Studio Team Services (VSTS)
  • AZURE – integration with Azure DevOps Server
  • TFS_SERVER – integration with Team Foundation Server (TFS)
  • AWS – integration with AWS CodeCommit
  • GERRIT – integration with Gerrit Code Review

    GIJFacade.createIntegration(): Required.

    GIJFacade.updateIntegration(): is not allowed to be changed.

Parameters

  • type: type of a new integration

setUsername(String)

Sets as username for the git host. Leave blank and use PAT if 2FA is enabled on the git server.

Parameters

  • username:
Have feedback about this article? Did we miss something? Let us know!
On this page