tools/telemetry/third_party/gsutilz/gslib/cloud_api_helper.py

   1 # -*- coding: utf-8 -*-
   2 # Copyright 2014 Google Inc. All Rights Reserved.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 """Helper functions for Cloud API implementations."""
  16
  17 from __future__ import absolute_import
  18
  19 from gslib.cloud_api import ArgumentException
  20
  21
  22 def ValidateDstObjectMetadata(dst_obj_metadata):
  23   """Ensures dst_obj_metadata supplies the needed fields for copy and insert.
  24
  25   Args:
  26     dst_obj_metadata: Metadata to validate.
  27
  28   Raises:
  29     ArgumentException if metadata is invalid.
  30   """
  31   if not dst_obj_metadata:
  32     raise ArgumentException(
  33         'No object metadata supplied for destination object.')
  34   if not dst_obj_metadata.name:
  35     raise ArgumentException(
  36         'Object metadata supplied for destination object had no object name.')
  37   if not dst_obj_metadata.bucket:
  38     raise ArgumentException(
  39         'Object metadata supplied for destination object had no bucket name.')
  40
  41
  42 def GetDownloadSerializationDict(src_obj_metadata):
  43   """Returns a baseline serialization dict from the source object metadata.
  44
  45   There are four entries:
  46     auto_transfer: JSON-specific field, always False.
  47     progress: How much of the download has already been completed. Caller
  48               should override this value if the download is being resumed.
  49     total_size: Total object size.
  50     url: Implementation-specific field used for saving a metadata get call.
  51          For JSON, this the download URL of the object.
  52          For XML, this is a pickled boto key.
  53
  54   Args:
  55     src_obj_metadata: Object to be downloaded.
  56
  57   Returns:
  58     Serialization dict for use with Cloud API GetObjectMedia.
  59   """
  60   return {
  61       'auto_transfer': 'False',
  62       'progress': 0,
  63       'total_size': src_obj_metadata.size,
  64       'url': src_obj_metadata.mediaLink
  65   }