Skip to main content

Initializer

Properties


defaultsOptional

  • Type: typing.Mapping[typing.Any]

workspaceOptional

  • Type: str

addressRequired

  • Type: str
(Required) The address of the REST endpoint.

client_ca_certificate_pemOptional

  • Type: str
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

client_certificate_pemOptional

  • Type: str
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

client_private_key_pemOptional

  • Type: str
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

lock_addressOptional

  • Type: str
(Optional) The address of the lock REST endpoint. Defaults to disabled.

lock_methodOptional

  • Type: str
(Optional) The HTTP method to use when locking. Defaults to LOCK.

passwordOptional

  • Type: str
(Optional) The password for HTTP basic authentication.

retry_maxOptional

  • Type: typing.Union[int, float]
(Optional) The number of HTTP request retries. Defaults to 2.

retry_wait_maxOptional

  • Type: typing.Union[int, float]
(Optional) The maximum time in seconds to wait between HTTP request attempts. Defaults to 30.

retry_wait_minOptional

  • Type: typing.Union[int, float]
(Optional) The minimum time in seconds to wait between HTTP request attempts. Defaults to 1.

skip_cert_verificationOptional

  • Type: bool
(Optional) Whether to skip TLS verification. Defaults to false.

unlock_addressOptional

  • Type: str
(Optional) The address of the unlock REST endpoint. Defaults to disabled.

unlock_methodOptional

  • Type: str
(Optional) The HTTP method to use when unlocking. Defaults to UNLOCK.

update_methodOptional

  • Type: str
(Optional) HTTP method to use when updating state. Defaults to POST.

usernameOptional

  • Type: str
(Optional) The username for HTTP basic authentication.