Gen3 Object Class

class gen3.object.Gen3Object(auth_provider=None)[source]

Bases: object

For interacting with Gen3 object level features.

A class for interacting with the Gen3 object services. Currently allows creating and deleting of an object from the Gen3 System.

Parameters:

auth_provider (Gen3Auth) – A Gen3Auth class instance.

Examples

This generates the Gen3Object class pointed at the sandbox commons while using the credentials.json downloaded from the commons profile page.

>>> auth = Gen3Auth(refresh_file="credentials.json")
... object = Gen3Object(auth)
delete_object(guid, delete_file_locations=False)[source]

Delete the object from indexd, metadata service and optionally all storage locations

Parameters:

  • delete (guid -- GUID of the object to)

  • True (delete_file_locations -- if)

  • location (removes the object from existing bucket)

Returns:

Nothing