Created
February 11, 2016 22:05
-
-
Save jgeewax/239a926fb37428e99e8e to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"methods": [ | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client`", | |
"description": "A client which holds credentials and project configuration for the bucket (which requires a project)." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "name", | |
"types": "string", | |
"description": "The name of the bucket." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket", | |
"name": "Bucket", | |
"constructor": true | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blob_name", | |
"types": "string", | |
"description": "The name of the blob to retrieve." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.get_blob", | |
"name": "get_blob", | |
"examples": [ | |
"Get a Blob from GCS\nfrom gcloud import storage\nclient = storage.Client()\nbucket = client.get_bucket('my-bucket')\nprint bucket.get_blob('/path/to/blob.txt')\n<Blob: my-bucket, /path/to/blob.txt>\nprint bucket.get_blob('/does-not-exist.txt')\nNone" | |
], | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "bucket_name", | |
"types": "string", | |
"description": "The bucket name in the path." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.path_helper", | |
"name": "path_helper", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.get_logging", | |
"name": "get_logging", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.exists", | |
"name": "exists", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "the client to use. If not passed, falls back to the ``client`` stored on the current object." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.reload", | |
"name": "reload", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.create", | |
"name": "create", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "the client to use. If not passed, falls back to the ``client`` stored on the current object." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.patch", | |
"name": "patch", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blob_name", | |
"types": "string", | |
"description": "The name of the blob to be instantiated." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "chunk_size", | |
"types": "integer", | |
"description": "The size of a chunk of data whenever iterating (1 MB). This must be a multiple of 256 KB per the API specification." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.blob", | |
"name": "blob", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blob_name", | |
"types": "string", | |
"description": "A blob name to delete." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.delete_blob", | |
"name": "delete_blob", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "new_name", | |
"types": "string", | |
"description": "(optional) the new name for the copied file." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blob", | |
"types": "class:`gcloud.storage.blob.Blob`", | |
"description": "The blob to be copied." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "destination_bucket", | |
"types": "class:`gcloud.storage.bucket.Bucket`", | |
"description": "The bucket into which the blob should be copied." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.copy_blob", | |
"name": "copy_blob", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "on_error", | |
"types": "a callable taking (blob)", | |
"description": "If not ``None``, called once for each blob raising :class:`gcloud.exceptions.NotFound`; otherwise, the exception is propagated." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blobs", | |
"types": "list of string or :class:`gcloud.storage.blob.Blob`", | |
"description": "A list of blob names or Blob objects to delete." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.delete_blobs", | |
"name": "delete_blobs", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.disable_logging", | |
"name": "disable_logging", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "new_name", | |
"types": "string", | |
"description": "The new name for this blob." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "blob", | |
"types": "class:`gcloud.storage.blob.Blob`", | |
"description": "The blob to be renamed." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.rename_blob", | |
"name": "rename_blob", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.location", | |
"name": "location", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "future", | |
"types": "boolean", | |
"description": "If True, this will make all objects created in the future public as well." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "recursive", | |
"types": "boolean", | |
"description": "If True, this will make all blobs inside the bucket public as well." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.make_public", | |
"name": "make_public", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.disable_website", | |
"name": "disable_website", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "main_page_suffix", | |
"types": "string", | |
"description": "The page to use as the main page of a directory. Typically something like index.html." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "not_found_page", | |
"types": "string", | |
"description": "The file to use when a page isn't found." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.configure_website", | |
"name": "configure_website", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "prefix", | |
"types": "string or ``NoneType``", | |
"description": "optional prefix used to filter blobs." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "projection", | |
"types": "string or ``NoneType``", | |
"description": "If used, must be 'full' or 'noAcl'. Defaults to 'noAcl'. Specifies the set of properties to return." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "versions", | |
"types": "boolean or ``NoneType``", | |
"description": "whether object versions should be returned as separate blobs." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "page_token", | |
"types": "string", | |
"description": "opaque marker for the next \"page\" of blobs. If not passed, will return the first page of blobs." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "max_results", | |
"types": "integer or ``NoneType``", | |
"description": "maximum number of blobs to return." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "delimiter", | |
"types": "string or ``NoneType``", | |
"description": "optional delimter, used with ``prefix`` to emulate hierarchy." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "fields", | |
"types": "string or ``NoneType``", | |
"description": "Selector specifying which fields to include in a partial response. Must be a list of fields. For example to get a partial response with just the next page token and the language of each blob returned: 'items/contentLanguage,nextPageToken'" | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.list_blobs", | |
"name": "list_blobs", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "object_prefix", | |
"types": "string", | |
"description": "prefix for access log filenames" | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "bucket_name", | |
"types": "string", | |
"description": "name of bucket in which to store access logs" | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.enable_logging", | |
"name": "enable_logging", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.__init__", | |
"name": "__init__", | |
"constructor": false | |
} | |
}, | |
{ | |
"exceptions": [], | |
"returns": [], | |
"params": [ | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "client", | |
"types": "class:`gcloud.storage.client.Client` or ``NoneType``", | |
"description": "Optional. The client to use. If not passed, falls back to the ``client`` stored on the current bucket." | |
}, | |
{ | |
"nullable": null, | |
"optional": null, | |
"name": "force", | |
"types": "boolean", | |
"description": "If True, empties the bucket's objects then deletes it." | |
} | |
], | |
"metadata": { | |
"id": "gcloud.storage.bucket.Bucket.delete", | |
"name": "delete", | |
"constructor": false | |
} | |
} | |
], | |
"id": "gcloud.storage.bucket", | |
"metadata": { | |
"name": "Bucket", | |
"description": "Create / interact with gcloud storage buckets." | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment