Initializer
Properties
| Name | Type | Description |
|---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
address | string | (Required) The address of the REST endpoint. |
clientCaCertificatePem | string | (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. |
clientCertificatePem | string | (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. |
clientPrivateKeyPem | string | (Optional) A PEM-encoded private key, required if client_certificate_pem is specified. |
lockAddress | string | (Optional) The address of the lock REST endpoint. |
lockMethod | string | (Optional) The HTTP method to use when locking. |
password | string | (Optional) The password for HTTP basic authentication. |
retryMax | number | (Optional) The number of HTTP request retries. |
retryWaitMax | number | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
retryWaitMin | number | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
skipCertVerification | boolean | (Optional) Whether to skip TLS verification. |
unlockAddress | string | (Optional) The address of the unlock REST endpoint. |
unlockMethod | string | (Optional) The HTTP method to use when unlocking. |
updateMethod | string | (Optional) HTTP method to use when updating state. |
username | string | (Optional) The username for HTTP basic authentication. |
defaultsOptional
- Type: {[ key: string ]: any}
workspaceOptional
- Type: string
addressRequired
- Type: string
clientCaCertificatePemOptional
- Type: string
clientCertificatePemOptional
- Type: string
clientPrivateKeyPemOptional
- Type: string
lockAddressOptional
- Type: string
lockMethodOptional
- Type: string
passwordOptional
- Type: string
retryMaxOptional
- Type: number
retryWaitMaxOptional
- Type: number
retryWaitMinOptional
- Type: number
skipCertVerificationOptional
- Type: boolean
unlockAddressOptional
- Type: string
unlockMethodOptional
- Type: string
updateMethodOptional
- Type: string
usernameOptional
- Type: string