Mixin: NimUrlHelperMixin

Members

---

nimSessionKey :string

A NIM session key.

Configuring this value is a convenient way to avoid having to pass the key to many of the *Url methods that require this value.

Type:

• string

Methods

---

authorizeImageSessionUrl()

Generate a URL for authorizing a new NIM session.

Returns:

the URL

Type

string

---

baseUrl()

Get the base URL to the NIM v1 REST API.

The returned URL uses the configured environment to resolve the hostUrl and the nimPath context path.

Returns:

the base URL to NIM

Type

string

---

createImageReceiptUrl(receiptId [, sessionKey])

Generate a URL for getting a receipt for an image creation request.

Parameters:

Name	Type	Argument	Description
receiptId	string		the ID of the image creation receipt returned from a call to /images/create/{imageId}/{sessionKey}
sessionKey	string	<optional>	the session key returned from a call to /images/authorize; if not provided the module:net~NimUrlHelperMixin#nimSessionKey value will be used

Returns:

the URL

Type

string

---

createImageUrl(imageId [, sessionKey])

Generate a URL for creating a custom image.

Parameters:

Name	Type	Argument	Description
imageId	string		the ID of the base image to customize
sessionKey	string	<optional>	the session key returned from a call to /images/authorize; if not provided the module:net~NimUrlHelperMixin#nimSessionKey value will be used

Returns:

the URL

Type

string

---

downloadImageUrl(receiptId [, sessionKey])

Generate a URL for downloading a completed image file.

Parameters:

Name	Type	Argument	Description
receiptId	string		the ID of the image creation receipt returned from a call to /images/create/{imageId}/{sessionKey}
sessionKey	string	<optional>	the session key returned from a call to /images/authorize; if not provided the module:net~NimUrlHelperMixin#nimSessionKey value will be used

Returns:

the URL

Type

string

---

listBaseImagesUrl()

Generate a URL for listing the available base images.

Returns:

the URL

Type

string

---

pingUrl()

Generate a URL for the "ping" health test URL.

Returns:

the URL

Type

string