deployment
This section documents the deployment element used to attach files to a bundle.
Subsections of deployment
Deployment Element
This is the base object for everything you can do with a deployment element.
createWithFile(rawFile)
This invokes a request to the OpenGate North API and the callback is managed by promises. This method creates a deployment element.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| rawFile | File |
❌ | this File is the deployment element |
Retorna
Tip
Tipo: Promise
deploy()
This invokes a request to the OpenGate North API and the callback is managed by promises. This method creates a deployment element with the previously assigned file.
Retorna
Tip
Tipo: Promise
update()
This method invalidates the update option
withDownloadUrl(downloadUrl)
Set the downloadUrl attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| downloadUrl | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withFile(rawFile)
Sets the file to upload
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| rawFile | object |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withFileName(fileName)
Set the fileName attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| fileName | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withName(name)
Set the name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement
withOldName(name)
Sets the old name attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withOldPath(path)
Sets the old path attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| path | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withOldVersion(version)
Sets the old version attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| version | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withOperation(operation)
Set the operation attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| operation | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement
withOption(option)
Set the option attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| option | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withOrder(order)
Set the order attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| order | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement
withPath(path)
Set the path attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| path | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement
withTimeout(ms)
The request will have a specific time out if it will be exceeded then the promise throw an exception
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ms | number |
❌ | timeout in milliseconds |
Retorna
Tip
Tipo: Bundles
withType(type)
Set the type attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| type | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement
withValidation(validation)
Set the validation attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| validation | string |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withValidators(validators)
Set the validators attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| validators | Array |
❌ |
Retorna
Tip
Tipo: DeploymentElement
withVersion(version)
Set the version attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| version | string |
❌ | required field |
Retorna
Tip
Tipo: DeploymentElement