Initializer
Properties
| Name | Type | Description |
|---|---|---|
defaults | typing.Mapping[typing.Any] | No description. |
workspace | str | No description. |
address | str | (Required) The address of the REST endpoint. |
client_ca_certificate_pem | str | (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. |
client_certificate_pem | str | (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. |
client_private_key_pem | str | (Optional) A PEM-encoded private key, required if client_certificate_pem is specified. |
lock_address | str | (Optional) The address of the lock REST endpoint. |
lock_method | str | (Optional) The HTTP method to use when locking. |
password | str | (Optional) The password for HTTP basic authentication. |
retry_max | typing.Union[int, float] | (Optional) The number of HTTP request retries. |
retry_wait_max | typing.Union[int, float] | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
retry_wait_min | typing.Union[int, float] | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
skip_cert_verification | bool | (Optional) Whether to skip TLS verification. |
unlock_address | str | (Optional) The address of the unlock REST endpoint. |
unlock_method | str | (Optional) The HTTP method to use when unlocking. |
update_method | str | (Optional) HTTP method to use when updating state. |
username | str | (Optional) The username for HTTP basic authentication. |
defaultsOptional
- Type: typing.Mapping[typing.Any]
workspaceOptional
- Type: str
addressRequired
- Type: str
client_ca_certificate_pemOptional
- Type: str
client_certificate_pemOptional
- Type: str
client_private_key_pemOptional
- Type: str
lock_addressOptional
- Type: str
lock_methodOptional
- Type: str
passwordOptional
- Type: str
retry_maxOptional
- Type: typing.Union[int, float]
retry_wait_maxOptional
- Type: typing.Union[int, float]
retry_wait_minOptional
- Type: typing.Union[int, float]
skip_cert_verificationOptional
- Type: bool
unlock_addressOptional
- Type: str
unlock_methodOptional
- Type: str
update_methodOptional
- Type: str
usernameOptional
- Type: str