Add 'Blob.update_storage_class' API method. #3051

tseaver · 2017-02-22T21:59:37Z

Closes #2991.

storage/google/cloud/storage/blob.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

+# pylint: disable=too-many-lines


storage/google/cloud/storage/blob.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

+# pylint: disable=too-many-lines


storage/google/cloud/storage/blob.py

@@ -73,6 +75,9 @@ class Blob(_PropertyMixin):
    _CHUNK_SIZE_MULTIPLE = 256 * 1024
    """Number (256 KB, in bytes) that must divide the chunk size."""

+    _STORAGE_CLASSES = (
+        'STANDARD', 'NEARLINE', 'MULTI_REGIONAL', 'REGIONAL', 'COLDLINE')


storage/google/cloud/storage/blob.py

@@ -852,6 +857,31 @@ def rewrite(self, source, token=None, client=None):

        return api_response['rewriteToken'], rewritten, size

+    def update_storage_class(self, new_class, client=None):


storage/google/cloud/storage/blob.py

@@ -852,6 +857,31 @@ def rewrite(self, source, token=None, client=None):

        return api_response['rewriteToken'], rewritten, size

+    def update_storage_class(self, new_class, client=None):
+        """Rewrite source blob into this one.


storage/google/cloud/storage/blob.py

+        :param new_class: new storage class for the object
+
+        :type client: :class:`~google.cloud.storage.client.Client` or
+                      ``NoneType``


storage/google/cloud/storage/blob.py

+            self._encryption_key, source=True))
+
+        api_response = client._connection.api_request(
+            method='POST', path=self.path + '/rewriteTo' + self.path,


storage/google/cloud/storage/blob.py

+
+        api_response = client._connection.api_request(
+            method='POST', path=self.path + '/rewriteTo' + self.path,
+            data={'storageClass': new_class}, headers=headers,


storage/unit_tests/test_blob.py

+        self.assertNotIn('X-Goog-Copy-Source-Encryption-Key-Sha256', headers)
+        self.assertNotIn('X-Goog-Encryption-Algorithm', headers)
+        self.assertNotIn('X-Goog-Encryption-Key', headers)
+        self.assertNotIn('X-Goog-Encryption-Key-Sha256', headers)


Closes #2991.

Addresses: #3051 (comment)

dhermes · 2017-02-23T20:53:39Z

Two remaining sticking points:

A tracking issue for obj. storage class in the Blob constructor
Making sure we don't repeat ourselves on the list of storage classes in blob and bucket modules

tseaver · 2017-02-23T21:23:42Z

@dhermes

A tracking issue for obj. storage class in the Blob constructor

#3062.

Making sure we don't repeat ourselves on the list of storage classes in blob and bucket modules

The two sets aren't identical: in particular, the DRA class is only documented for Buckets, although it is deprecated, while the 'STANDARD' class isn't documented for POSC at all (although it happens to work).

lukesneeringer · 2017-02-23T21:33:59Z

The two sets aren't identical: in particular, the DRA class is only documented for Buckets, although it is deprecated, while the 'STANDARD' class isn't documented for POSC at all (although it happens to work).

Is one a strict superset of the other? If so, the module with the larger set could import the smaller one and .union on it. (You'd also have to change to sets rather than tuples, which would be fine.)

If neither set is a strict superset of the other, I agree with @tseaver that they should just be separate (rather than, say, having a base set that is the intersection).

tseaver · 2017-02-23T21:55:58Z

Is one a strict superset of the other?

@lukesneeringer By inspection of the documented values at point-of-last-reading, yes: however, the docs don't specify that: they just describe the two sets which happen to overlap:

The Bucket resource spec lists all the values currently laid out in our Bucket._STORAGE_CLASSES member.
The Object resource spec doesn't list any values at all (boo, hiss!)
The Storage Classes concept doc lists only four (multi-regional, regional, nearline, and coldline), and defines STANDARD as an alias based on the bucket's location type. It documents DRA as a deprecated version, pushing use of multi-regional or regional instead.
The Per-Object Storage Class concept docs only allow for the four types: I found by inspection that STANDARD is settable, and is the value which a new object shows in its resource if the bucket specified no storage class.

We could perhaps coalesce the two lists if we dropped support for setting the DRA type on buckets, or if we could get the storage back-end folks to document the possible values definitively for both buckets and objects.

lukesneeringer · 2017-02-24T04:50:37Z

Okay, got it. Based on that, I think I am going to say that we stick with @tseaver's approach as implemented for now (while acknowledging that it is a close call).

dhermes · 2017-02-24T17:40:06Z

@lukesneeringer @tseaver We should

include a comment in code explaining why the duplication
give feedback to the backend folks that we had to duplicate / the choices don't seem clear from the docs (/cc @jonparrott)

tseaver · 2017-02-24T18:03:13Z

@dhermes ~~c34cd86~~7be81cf adds docstrings to both class attributes, including links to the relevant back-end documentation.

Re-order to match canonical order in docs. Add docstrings with links to relevant docs. Explain why the two lists differ.

tseaver · 2017-02-27T15:46:00Z

@dhermes, @lukesneeringer Any further issues?

Addresses: googleapis#3051 (comment)

…ct_storage_class Add 'Blob.update_storage_class' API method.

Addresses: googleapis/google-cloud-python#3051 (comment)

tseaver added api: storage Issues related to the Cloud Storage API. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Feb 22, 2017

tseaver requested review from daspecster and dhermes February 22, 2017 21:59

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 22, 2017

daspecster reviewed Feb 22, 2017

View reviewed changes

storage/google/cloud/storage/blob.py

@@ -12,6 +12,8 @@

# See the License for the specific language governing permissions and

# limitations under the License.

# pylint: disable=too-many-lines

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

dhermes reviewed Feb 22, 2017

View reviewed changes

tseaver added 2 commits February 22, 2017 18:26

Add 'Blob.update_storage_class' API method.

087a7fb

Closes #2991.

Add unit test for 'Blob.update_storage_class' w/ enc. key.

f1a03ea

Addresses: #3051 (comment)

tseaver mentioned this pull request Feb 23, 2017

Enable setting 'Blob.storage_class' before upload #3062

Closed

Document '{Bucket,Blob}._STORAGE_CLASSES'.

7be81cf

Re-order to match canonical order in docs. Add docstrings with links to relevant docs. Explain why the two lists differ.

lukesneeringer approved these changes Feb 27, 2017

View reviewed changes

tseaver merged commit de5d8e1 into googleapis:master Feb 27, 2017

tseaver deleted the 2991-storage-per_object_storage_class branch March 3, 2017 21:51

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017

Add unit test for 'Blob.update_storage_class' w/ enc. key.

fb17115

Addresses: googleapis#3051 (comment)

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017

Merge pull request googleapis#3051 from tseaver/2991-storage-per_obje…

9c87e04

…ct_storage_class Add 'Blob.update_storage_class' API method.

crwilcox pushed a commit to googleapis/python-storage that referenced this pull request Jan 31, 2020

Add unit test for 'Blob.update_storage_class' w/ enc. key.

43d84c2

Addresses: googleapis/google-cloud-python#3051 (comment)

cojenco pushed a commit to cojenco/python-storage that referenced this pull request Oct 13, 2021

Add unit test for 'Blob.update_storage_class' w/ enc. key.

4538b4e

Addresses: googleapis/google-cloud-python#3051 (comment)

cojenco pushed a commit to cojenco/python-storage that referenced this pull request Oct 13, 2021

Add unit test for 'Blob.update_storage_class' w/ enc. key.

26b0966

Addresses: googleapis/google-cloud-python#3051 (comment)

		@@ -852,6 +857,31 @@ def rewrite(self, source, token=None, client=None):

		return api_response['rewriteToken'], rewritten, size

		def update_storage_class(self, new_class, client=None):

Add 'Blob.update_storage_class' API method. #3051

Add 'Blob.update_storage_class' API method. #3051

Conversation

tseaver commented Feb 22, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

dhermes commented Feb 23, 2017

tseaver commented Feb 23, 2017

lukesneeringer commented Feb 23, 2017 • edited Loading

tseaver commented Feb 23, 2017

lukesneeringer commented Feb 24, 2017

dhermes commented Feb 24, 2017

tseaver commented Feb 24, 2017 • edited Loading

tseaver commented Feb 27, 2017

lukesneeringer commented Feb 23, 2017 •

edited

Loading

tseaver commented Feb 24, 2017 •

edited

Loading