The Objects resource represents an object within Google Cloud Storage. Objects are pieces of data that you have uploaded to Google Cloud Storage. For more information, see
Object Name Requirements
.
Every object in Google Cloud Storage resides in a
bucket
. The object is owned by its original uploader, who will always retain
OWNER
permission on it.
In addition to the
acl
property, objects contain
objectAccessControls
, for use in fine-grained manipulation of an existing object's access controls.
For a list of methods for this resource, see the end of this page.
Resource representations
An object.
{
"kind": "storage#object",
"id": string,
"selfLink": string,
"name": string,
"bucket": string,
"media": {
"contentType": string,
"timeCreated": datetime,
"length": unsigned long,
"hash": string,
"algorithm": "MD5",
"link": string,
"data": bytes
},
"contentEncoding": string,
"contentDisposition": string,
"contentLanguage": string,
"cacheControl": string,
"metadata": {
(key): string
},
"acl": [
objectAccessControls Resource
],
"owner": {
"entity": string,
"entityId": string
}
}
| Property name | Value | Description | Notes |
|---|---|---|---|
kind
|
string
|
The kind of item this is. For objects, this is always
storage#object
.
|
|
id
|
string
|
The ID of the object. | |
selfLink
|
string
|
The link to this object. | |
name
|
string
|
The name of this object. Required if not specified by URL parameter. | writable |
bucket
|
string
|
The bucket containing this object. | |
media
|
object
|
Object media data. Provided on your behalf when uploading raw media or multipart/related with an auxiliary media part. | |
media.
contentType
|
string
|
Content-Type of the object data. | writable |
media.
timeCreated
|
datetime
|
Creation time of the data in RFC 3339 format. | |
media.
length
|
unsigned long
|
Content-Length of the data in bytes. | |
media.
hash
|
string
|
Hash of the data. Required if a hash algorithm is provided. | writable |
media.
algorithm
|
string
|
Hash algorithm used. Currently only
MD5
is supported. Required if a hash is provided.
|
writable |
media.
link
|
string
|
Media download link. | |
media.
data
|
bytes
|
URL-safe Base64-encoded data. This property can be used to insert objects under 64KB in size, and will only be returned in response to the get method for objects so created. When this resource is returned in response to the list method, this property is omitted. | |
contentEncoding
|
string
|
Content-Encoding of the object data. | writable |
contentDisposition
|
string
|
Content-Disposition of the object data. | writable |
cacheControl
|
string
|
Cache-Control directive for the object data. | writable |
metadata
|
object
|
User-provided metadata, in key/value pairs. | writable |
metadata.
(key)
|
string
|
An individual metadata entry. | writable |
acl[]
|
list
|
Access controls on the object. | writable |
owner
|
object
|
The owner of the object. This will always be the uploader of the object. | |
owner.
entity
|
string
|
The entity, in the form
user-
userId
.
|
|
owner.
entityId
|
string
|
The ID for the entity. | |
contentLanguage
|
string
|
Content-Language of the object data. | writable |
Methods
Available methods for Objects resources are as follows:
- delete
- Deletes data blobs and associated metadata.
- get
- Retrieves objects or their associated metadata.
- insert
- Stores new data blobs and associated metadata.
- list
- Retrieves a list of objects matching the criteria.
- patch
- Updates a data blob's associated metadata. This method supports patch semantics.
- update
- Updates a data blob's associated metadata.