Release 1.3.0

Author: IBMeric

CHANGELOG.md

@@ -1,26 +1,52 @@
 # CHANGELOG
 
-# 1.2.0
-## Content
-### Features
+## 1.3.0
+
+### Content
+
+#### Features
+
+* Block Public Anonymous Access
+
+#### Defect Fixes
+
+* Add language support policy
+
+## 1.2.0
+
+### Content
+
+#### Features
+
 * COS Usage Metrics Monitoring
 
-# 1.1.1
-## Content
+## 1.1.1
+
+### Content
+
 * No change. Refer to deprecation notice in README
 
-# 1.1.0
-## Content
-### Features
+## 1.1.0
+
+### Content
+
+#### Features
+
 * Activity Tracker
 
-# 1.0.1
-## Content
-### Defect Fixes
+## 1.0.1
+
+### Content
+
+#### Defect Fixes
+
 * This release repairs an issue with the SDK package on the PyPI repository
 
-# 1.0.0
-## Content
-### Features
+## 1.0.0
+
+### Content
+
+#### Features
+
 * Initial release - Deprecated due to issues with published binaries on PyPI. Please use 1.0.1
-* This Feature allows configuration of a firewall for a bucket to restrict access to a defined list of IP addresses
+* This Feature allows configuration of a firewall for a bucket to restrict access to a defined list of IP addresses

README.md

@@ -1,11 +1,10 @@
-# IBM COS Resource Configuration SDK for Python 
+# IBM COS Resource Configuration SDK for Python
 
-This package allows Python developers to write software that interacts with the Resource Configuration API for [IBM
-Cloud Object Storage](https://cloud.ibm.com/apidocs/cos/cos-configuration).
+This package allows Python developers to write software that interacts with the Resource Configuration API for [IBM Cloud Object Storage](https://cloud.ibm.com/apidocs/cos/cos-configuration).
 
 ## Notice
 
-IBM is officially deprecating support of Python versions 2.7 & 3.4.   All clients need to upgrade to version 3.5 or greater by January 31, 2020.
+IBM has added a [Language Support Policy](#language-support-policy). Language versions will be deprecated on the published schedule without additional notice.
 
 ## Documentation
 
@@ -17,32 +16,34 @@ For release notes, see the [CHANGELOG](CHANGELOG.md).
 
 ## Quick start
 
-You'll need:
-  * An instance of COS.
-  * An API key from [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/iam/users_roles.html).
-  * **Python 3.5, 3.6, or 3.7**.
+You will need:
 
-  These values can be found in the IBM Cloud Console by [generating a 'service credential'](https://cloud.ibm.com/docs/services/cloud-object-storage/iam/service-credentials.html).
+* An instance of COS.
+* An API key from [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/iam/users_roles.html).
+
+These values can be found in the IBM Cloud Console by [generating a 'service credential'](https://cloud.ibm.com/docs/services/cloud-object-storage/iam/service-credentials.html).
 
 ## Getting the SDK
-The preferred way to install the IBM COS Resource Configuration SDK for Python is to use the
-[pip](https://pypi.org/project/pip/) package manager. Simply type the following
-into a terminal window:
+
+The preferred way to install the IBM COS Resource Configuration SDK for Python is to use the [pip](https://pypi.org/project/pip/) package manager. Simply type the following into a terminal window:
 
 ```sh
 pip install ibm-cos-sdk-config
 ```
 
 ## Getting Help
+
 Feel free to use GitHub issues for tracking bugs and feature requests, but for help please use one of the following resources:
 
 * Read a quick start guide in [IBM Cloud Docs](https://cloud.ibm.com/docs/services/cloud-object-storage/).
 * Ask a question on [Stack Overflow](https://stackoverflow.com/) and tag it with ``ibm`` and ``object-storage``.
 * Open a support ticket with [IBM Cloud Support](https://cloud.ibm.com/unifiedsupport/supportcenter)
 * If it turns out that you may have found a bug, please [open an issue](https://github.com/ibm/ibm-cos-sdk-python-config/issues/new).
 
+## Language Support Policy
+
+IBM supports [current public releases](https://devguide.python.org/#status-of-python-branches). IBM will deprecate language versions 90 days after a version reaches end-of-life. All clients will need to upgrade to a supported version before the end of the grace period.
 
 ## License
 
-This SDK is distributed under the
-[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

cos_config/__init__.py

@@ -1,2 +1,2 @@
 __author__ = 'IBM'
-__version__ = '1.2.0'
+__version__ = '1.3.0'

cos_config/resource_configuration_v1.py

@@ -16,7 +16,8 @@
 
 """
 REST API used to configure Cloud Object Storage buckets.  This version of the API only
-supports reading bucket metadata and setting IP access controls.
+supports reading bucket metadata, setting IP access controls, and configuring logging and
+monitoring services.
 """
 
 from __future__ import absolute_import
@@ -194,7 +195,7 @@ class ActivityTracking(object):
     :attr bool write_data_events: (optional) If set to `true`, all object write events
     (i.e. uploads) will be sent to Activity Tracker.
     :attr str activity_tracker_crn: (optional) Required the first time `activity_tracking`
-    is configured. The instance of Activity Tracker that will recieve object event data.
+    is configured. The instance of Activity Tracker that will receive object event data.
     The format is "crn:v1:bluemix:public:logdnaat:{bucket location}:a/{storage
     account}:{activity tracker service instance}::".
     """
@@ -209,7 +210,7 @@ def __init__(self, read_data_events=None, write_data_events=None, activity_track
         events (i.e. uploads) will be sent to Activity Tracker.
         :param str activity_tracker_crn: (optional) Required the first time
         `activity_tracking` is configured. The instance of Activity Tracker that will
-        recieve object event data. The format is "crn:v1:bluemix:public:logdnaat:{bucket
+        receive object event data. The format is "crn:v1:bluemix:public:logdnaat:{bucket
         location}:a/{storage account}:{activity tracker service instance}::".
         """
         self.read_data_events = read_data_events
@@ -419,36 +420,67 @@ class Firewall(object):
     to be affected by firewall in CIDR notation is supported. Passing an empty array will
     lift the IP address filter.  The `allowed_ip` array can contain a maximum of 1000
     items.
+    :attr list[str] denied_ip: (optional) List of IPv4 or IPv6 addresses in CIDR notation
+    to be affected by firewall in CIDR notation is supported. Passing an empty array will
+    lift the IP address filter.  The `denied_ip` array can contain a maximum of 1000
+    items.
+    :attr list[str] allowed_network_type: (optional) Indicates which network types are
+    allowed for bucket access. May contain `public`, `private`, and/or `direct` elements.
+    Setting `allowed_network_type` to only `private` will prevent access to object storage
+    from outside of the IBM Cloud.  The entire array will be overwritten in a `PATCH`
+    operation. For more information on network types, [see the
+    documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types).
     """
 
-    def __init__(self, allowed_ip=None):
+    def __init__(self, allowed_ip=None, denied_ip=None, allowed_network_type=None):
         """
         Initialize a Firewall object.
 
         :param list[str] allowed_ip: (optional) List of IPv4 or IPv6 addresses in CIDR
         notation to be affected by firewall in CIDR notation is supported. Passing an
         empty array will lift the IP address filter.  The `allowed_ip` array can contain a
         maximum of 1000 items.
+        :param list[str] denied_ip: (optional) List of IPv4 or IPv6 addresses in CIDR
+        notation to be affected by firewall in CIDR notation is supported. Passing an
+        empty array will lift the IP address filter.  The `denied_ip` array can contain a
+        maximum of 1000 items.
+        :param list[str] allowed_network_type: (optional) Indicates which network types
+        are allowed for bucket access. May contain `public`, `private`, and/or `direct`
+        elements. Setting `allowed_network_type` to only `private` will prevent access to
+        object storage from outside of the IBM Cloud.  The entire array will be
+        overwritten in a `PATCH` operation. For more information on network types, [see
+        the
+        documentation](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types).
         """
         self.allowed_ip = allowed_ip
+        self.denied_ip = denied_ip
+        self.allowed_network_type = allowed_network_type
 
     @classmethod
     def _from_dict(cls, _dict):
         """Initialize a Firewall object from a json dictionary."""
         args = {}
-        validKeys = ['allowed_ip']
+        validKeys = ['allowed_ip', 'denied_ip', 'allowed_network_type']
         badKeys = set(_dict.keys()) - set(validKeys)
         if badKeys:
             raise ValueError('Unrecognized keys detected in dictionary for class Firewall: ' + ', '.join(badKeys))
         if 'allowed_ip' in _dict:
             args['allowed_ip'] = _dict.get('allowed_ip')
+        if 'denied_ip' in _dict:
+            args['denied_ip'] = _dict.get('denied_ip')
+        if 'allowed_network_type' in _dict:
+            args['allowed_network_type'] = _dict.get('allowed_network_type')
         return cls(**args)
 
     def _to_dict(self):
         """Return a json dictionary representing this model."""
         _dict = {}
         if hasattr(self, 'allowed_ip') and self.allowed_ip is not None:
             _dict['allowed_ip'] = self.allowed_ip
+        if hasattr(self, 'denied_ip') and self.denied_ip is not None:
+            _dict['denied_ip'] = self.denied_ip
+        if hasattr(self, 'allowed_network_type') and self.allowed_network_type is not None:
+            _dict['allowed_network_type'] = self.allowed_network_type
         return _dict
 
     def __str__(self):

requirements-docs.txt

@@ -1,3 +1,4 @@
+docutils>=0.10,<0.15
 Sphinx>=1.1.3,<1.3
 guzzle_sphinx_theme>=0.7.10,<0.8
 -rrequirements.txt