Class Application
java.lang.Object
dev.getelements.elements.sdk.model.application.Application
- All Implemented Interfaces:
Serializable
Represents an application. This serves as place to house the
application's basic metadata such as app id and display name.
Since an application can exist on multiple platforms, this seeks
to simply tie all platforms together.
Created by patricktwohig on 7/9/15.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Used as the key for the application attribute where appropriate. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets the application configuration for this application, if this is available.Gets the description.Gets the git branch of the application.Gets the HTTP documentation UI URL for the application if it is available.Gets the HTTP documentation endpoint for the application if it is available.Gets the HTTP tunnel endpoint, if this is available.getId()
The globally-unique identifier.getName()
Gets the unique name of the application.Gets script repo URL.int
hashCode()
void
setApplicationConfiguration
(ApplicationConfiguration applicationConfiguration) Sets the application configuration.void
setAttributes
(Map<String, Object> attributes) void
setDescription
(String description) Sets the description.void
setGitBranch
(String gitBranch) Sets the git branch of the application.void
setHttpDocumentationUiUrl
(String httpDocumentationUiUrl) Sets the HTTP documentation UI URL for the application if it is available.void
setHttpDocumentationUrl
(String httpDocumentationUrl) Sets the HTTP documentation endpoint for the application if it is available.void
setHttpTunnelEndpointUrl
(String httpTunnelEndpointUrl) Sets the HTTP tunnel endpoint, if this is available.void
The identifier.void
Sets the unique name of the application.void
setScriptRepoUrl
(String scriptRepoUrl) Sets the script repo URL.
-
Field Details
-
APPLICATION_ATTRIBUTE
Used as the key for the application attribute where appropriate. This is equivalent to the FQN of theApplication
class.
-
-
Constructor Details
-
Application
public Application()
-
-
Method Details
-
getId
The globally-unique identifier.- Returns:
- the identifier
-
setId
The identifier.- Parameters:
id
- the identifier
-
getName
Gets the unique name of the application. Must be alpha-numeric as it is used to form REST URLs.- Returns:
-
setName
Sets the unique name of the application.- Parameters:
name
-
-
getGitBranch
Gets the git branch of the application. If blank, assume the default branch.- Returns:
- the git branch
-
setGitBranch
Sets the git branch of the application. If blank, assume the default branch.- Parameters:
gitBranch
- the git branch
-
getDescription
Gets the description. This is just an optional description for the application used for reference.- Returns:
-
setDescription
Sets the description.- Parameters:
description
-
-
getScriptRepoUrl
Gets script repo URL.- Returns:
- the script repo URL
-
setScriptRepoUrl
Sets the script repo URL.- Parameters:
scriptRepoUrl
- the script repo URL
-
getHttpDocumentationUrl
Gets the HTTP documentation endpoint for the application if it is available. Otherwise null.- Returns:
- the HTTP documentation endpoint
-
setHttpDocumentationUrl
Sets the HTTP documentation endpoint for the application if it is available. Otherwise null.- Parameters:
httpDocumentationUrl
- the HTTP documentation endpoint
-
getHttpDocumentationUiUrl
Gets the HTTP documentation UI URL for the application if it is available. Otherwise null.- Returns:
- the HTTP documentation UI url
-
setHttpDocumentationUiUrl
Sets the HTTP documentation UI URL for the application if it is available. Otherwise null.- Parameters:
httpDocumentationUiUrl
- the HTTP documentation UI url
-
getHttpTunnelEndpointUrl
Gets the HTTP tunnel endpoint, if this is available. Otherwise null.- Returns:
- the HTTP tunnel endpoint
-
setHttpTunnelEndpointUrl
Sets the HTTP tunnel endpoint, if this is available. Otherwise null.- Parameters:
httpTunnelEndpointUrl
- the HTTP tunnel endpoint
-
getApplicationConfiguration
Gets the application configuration for this application, if this is available. Otherwise null.- Returns:
- the application configuration
-
setApplicationConfiguration
Sets the application configuration.- Parameters:
applicationConfiguration
- the application configuration
-
equals
-
hashCode
public int hashCode() -
getAttributes
-
setAttributes
-