import DeploymentElement from 'opengate-js/src/bundles/deployment/DeploymentElement.js'

public class | source

DeploymentElement

Extends:

BaseProvision → DeploymentElement

This is a base object that contains all you can do about Deployment Element.

Constructor Summary

Public Constructor
public	constructor(context: , ogapi: , url: , progressEvent: )

Member Summary

Public Members
public	validation: boolean

Method Summary

Public Methods
public	createWithFile(rawFile: File): Promise This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement
public	deploy(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement with previously assignated file
public	update() This method invalidates the update option
public	withDownloadUrl(downloadUrl: string): DeploymentElement Set the downloadUrl attribute
public	withFile(rawFile: object): DeploymentElement Sets the file to upload
public	withFileName(fileName: string): DeploymentElement Set the fileName attribute
public	withName(name: string): DeploymentElement Set the name attribute
public	withOldName(name: string): DeploymentElement Sets the old name attribute
public	withOldPath(path: string): DeploymentElement Sets the old path attribute
public	withOldVersion(version: string): DeploymentElement Sets the old version attribute
public	withOperation(operation: string): DeploymentElement Set the operation attribute
public	withOption(option: string): DeploymentElement Set the option attribute
public	withOrder(order: string): DeploymentElement Set the order attribute
public	withPath(path: string): DeploymentElement Set the path attribute
public	withTimeout(ms: number): Bundles The request will have a specific time out if it will be exceeded then the promise throw an exception
public	withType(type: string): DeploymentElement Set the type attribute
public	withValidation(validation: string): DeploymentElement Set the validation attribute
public	withValidators(validators: Array): DeploymentElement Set the validators attribute
public	withVersion(version: string): DeploymentElement Set the version attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(context: , ogapi: , url: , progressEvent: ) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
context	*
ogapi	*
url	*
progressEvent	*

Public Members

public validation: boolean source

Public Methods

public createWithFile(rawFile: File): Promise source

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement

Params:

Name	Type	Attribute	Description
rawFile	File		this File is the deployment element

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public deploy(): Promise source

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element deploymentElement with previously assignated file

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public update() source

This method invalidates the update option

Override:

BaseProvision#update

Throw:

Allways

Deployment elements cannot be updated.

public withDownloadUrl(downloadUrl: string): DeploymentElement source

Set the downloadUrl attribute

Params:

Name	Type	Attribute	Description
downloadUrl	string

Return:

DeploymentElement

public withFile(rawFile: object): DeploymentElement source

Sets the file to upload

Params:

Name	Type	Attribute	Description
rawFile	object

Return:

DeploymentElement

public withFileName(fileName: string): DeploymentElement source

Set the fileName attribute

Params:

Name	Type	Attribute	Description
fileName	string

Return:

DeploymentElement

public withName(name: string): DeploymentElement source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

DeploymentElement

public withOldName(name: string): DeploymentElement source

Sets the old name attribute

Params:

Name	Type	Attribute	Description
name	string

Return:

DeploymentElement

public withOldPath(path: string): DeploymentElement source

Sets the old path attribute

Params:

Name	Type	Attribute	Description
path	string

Return:

DeploymentElement

public withOldVersion(version: string): DeploymentElement source

Sets the old version attribute

Params:

Name	Type	Attribute	Description
version	string

Return:

DeploymentElement

public withOperation(operation: string): DeploymentElement source

Set the operation attribute

Params:

Name	Type	Attribute	Description
operation	string		required field

Return:

DeploymentElement

public withOption(option: string): DeploymentElement source

Set the option attribute

Params:

Name	Type	Attribute	Description
option	string

Return:

DeploymentElement

public withOrder(order: string): DeploymentElement source

Set the order attribute

Params:

Name	Type	Attribute	Description
order	string		required field

Return:

DeploymentElement

public withPath(path: string): DeploymentElement source

Set the path attribute

Params:

Name	Type	Attribute	Description
path	string		required field

Return:

DeploymentElement

public withTimeout(ms: number): Bundles source

The request will have a specific time out if it will be exceeded then the promise throw an exception

Params:

Name	Type	Attribute	Description
ms	number		timeout in milliseconds

Return:

Bundles

public withType(type: string): DeploymentElement source

Set the type attribute

Params:

Name	Type	Attribute	Description
type	string		required field

Return:

DeploymentElement

public withValidation(validation: string): DeploymentElement source

Set the validation attribute

Params:

Name	Type	Attribute	Description
validation	string

Return:

DeploymentElement

public withValidators(validators: Array): DeploymentElement source

Set the validators attribute

Params:

Name	Type	Attribute	Description
validators	Array

Return:

DeploymentElement

public withVersion(version: string): DeploymentElement source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string		required field

Return:

DeploymentElement

DeploymentElement

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(context: *, ogapi: *, url: *, progressEvent: *) source

Override:

Params:

Public Members

public validation: boolean source

Public Methods

public createWithFile(rawFile: File): Promise source

Params:

Return:

Return Properties:

public deploy(): Promise source

Return:

Return Properties:

public update() source

Override:

Throw:

public withDownloadUrl(downloadUrl: string): DeploymentElement source

Params:

Return:

public withFile(rawFile: object): DeploymentElement source

Params:

Return:

public withFileName(fileName: string): DeploymentElement source

Params:

Return:

public withName(name: string): DeploymentElement source

Params:

Return:

public withOldName(name: string): DeploymentElement source

Params:

Return:

public withOldPath(path: string): DeploymentElement source

Params:

Return:

public withOldVersion(version: string): DeploymentElement source

Params:

Return:

public withOperation(operation: string): DeploymentElement source

Params:

Return:

public withOption(option: string): DeploymentElement source

Params:

Return:

public withOrder(order: string): DeploymentElement source

Params:

Return:

public withPath(path: string): DeploymentElement source

Params:

Return:

public withTimeout(ms: number): Bundles source

Params:

Return:

public withType(type: string): DeploymentElement source

Params:

Return:

public withValidation(validation: string): DeploymentElement source

Params:

Return:

public withValidators(validators: Array): DeploymentElement source

Params:

Return:

public withVersion(version: string): DeploymentElement source

Params:

Return:

public constructor(context: , ogapi: , url: , progressEvent: ) source