summaryrefslogtreecommitdiff
path: root/kafka/client_async.py
diff options
context:
space:
mode:
authorJeff Widman <jeff@jeffwidman.com>2018-04-24 13:02:39 -0700
committerGitHub <noreply@github.com>2018-04-24 13:02:39 -0700
commit27f939ad528a5f7f71346c3d9b18e1a9aa9404e5 (patch)
treebcd83442a923449615b7fe0a711a92840735355d /kafka/client_async.py
parentafc6346d05054faf75e30a01b9e41a9916e703a9 (diff)
downloadkafka-python-27f939ad528a5f7f71346c3d9b18e1a9aa9404e5.tar.gz
Minor doc capitalization cleanup
Diffstat (limited to 'kafka/client_async.py')
-rw-r--r--kafka/client_async.py30
1 files changed, 15 insertions, 15 deletions
diff --git a/kafka/client_async.py b/kafka/client_async.py
index c620aa8..9556eca 100644
--- a/kafka/client_async.py
+++ b/kafka/client_async.py
@@ -99,26 +99,26 @@ class KafkaClient(object):
brokers or partitions. Default: 300000
security_protocol (str): Protocol used to communicate with brokers.
Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
- ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping
+ ssl_context (ssl.SSLContext): Pre-configured SSLContext for wrapping
socket connections. If provided, all other ssl_* configurations
will be ignored. Default: None.
- ssl_check_hostname (bool): flag to configure whether ssl handshake
- should verify that the certificate matches the brokers hostname.
- default: true.
- ssl_cafile (str): optional filename of ca file to use in certificate
- veriication. default: none.
- ssl_certfile (str): optional filename of file in pem format containing
- the client certificate, as well as any ca certificates needed to
- establish the certificate's authenticity. default: none.
- ssl_keyfile (str): optional filename containing the client private key.
- default: none.
- ssl_password (str): optional password to be used when loading the
- certificate chain. default: none.
- ssl_crlfile (str): optional filename containing the CRL to check for
+ ssl_check_hostname (bool): Flag to configure whether SSL handshake
+ should verify that the certificate matches the broker's hostname.
+ Default: True.
+ ssl_cafile (str): Optional filename of CA file to use in certificate
+ veriication. Default: None.
+ ssl_certfile (str): Optional filename of file in PEM format containing
+ the client certificate, as well as any CA certificates needed to
+ establish the certificate's authenticity. Default: None.
+ ssl_keyfile (str): Optional filename containing the client private key.
+ Default: None.
+ ssl_password (str): Optional password to be used when loading the
+ certificate chain. Default: None.
+ ssl_crlfile (str): Optional filename containing the CRL to check for
certificate expiration. By default, no CRL check is done. When
providing a file, only the leaf certificate will be checked against
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
- default: none.
+ Default: None.
api_version (tuple): Specify which Kafka API version to use. If set
to None, KafkaClient will attempt to infer the broker version by
probing various APIs. Example: (0, 10, 2). Default: None