def delete_batch_centroid(self, batch_centroid):
"""Deletes a batch centroid.
"""
check_resource_type(batch_centroid, BATCH_CENTROID_PATH,
message="A batch centroid id is needed.")
batch_centroid_id = get_batch_centroid_id(batch_centroid)
if batch_centroid_id:
return self._delete("%s%s" % (self.url, batch_centroid_id))
def update_batch_centroid(self, batch_centroid, changes):
"""Updates a batch centroid.
"""
check_resource_type(batch_centroid, BATCH_CENTROID_PATH,
message="A batch centroid id is needed.")
batch_centroid_id = get_batch_centroid_id(batch_centroid)
if batch_centroid_id:
body = json.dumps(changes)
return self._update("%s%s" % (self.url, batch_centroid_id), body)
def download_batch_centroid(self, batch_centroid, filename=None):
"""Retrieves the batch centroid file.
Downloads centroids, that are stored in a remote CSV file. If
a path is given in filename, the contents of the file are downloaded
and saved locally. A file-like object is returned otherwise.
"""
check_resource_type(batch_centroid, BATCH_CENTROID_PATH,
message="A batch centroid id is needed.")
batch_centroid_id = get_batch_centroid_id(batch_centroid)
if batch_centroid_id:
return self._download("%s%s%s" % (self.url, batch_centroid_id,
DOWNLOAD_DIR), filename=filename)
def get_batch_centroid(self, batch_centroid):
"""Retrieves a batch centroid.
The batch_centroid parameter should be a string containing the
batch_centroid id or the dict returned by create_batch_centroid.
As batch_centroid is an evolving object that is processed
until it reaches the FINISHED or FAULTY state, the function will
return a dict that encloses the batch_centroid values and state
info available at the time it is called.
"""
check_resource_type(batch_centroid, BATCH_CENTROID_PATH,
message="A batch centroid id is needed.")
batch_centroid_id = get_batch_centroid_id(batch_centroid)
if batch_centroid_id:
return self._get("%s%s" % (self.url, batch_centroid_id))
def get_batch_centroid(self, batch_centroid):
"""Retrieves a batch centroid.
The batch_centroid parameter should be a string containing the
batch_centroid id or the dict returned by create_batch_centroid.
As batch_centroid is an evolving object that is processed
until it reaches the FINISHED or FAULTY state, the function will
return a dict that encloses the batch_centroid values and state
info available at the time it is called.
"""
check_resource_type(batch_centroid,
BATCH_CENTROID_PATH,
message="A batch centroid id is needed.")
batch_centroid_id = get_batch_centroid_id(batch_centroid)
if batch_centroid_id:
return self._get("%s%s" % (self.url, batch_centroid_id))
