1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Storage
  7. \
  8. Resource
  9. \
  10. ObjectAccessControls

ObjectAccessControls

class ObjectAccessControls extends Resource (View source)

The "objectAccessControls" collection of methods.

Typical usage is:

 $storageService = new Google\Service\Storage(...);
 $objectAccessControls = $storageService->objectAccessControls;

Methods

delete(string $bucket, string $object, string $entity, array $optParams = [])

Permanently deletes the ACL entry for the specified entity on the specified object. (objectAccessControls.delete)

ObjectAccessControl
get(string $bucket, string $object, string $entity, array $optParams = [])

Returns the ACL entry for the specified entity on the specified object.

ObjectAccessControl
insert(string $bucket, string $object, ObjectAccessControl $postBody, array $optParams = [])

Creates a new ACL entry on the specified object.

ObjectAccessControls
listObjectAccessControls(string $bucket, string $object, array $optParams = [])

Retrieves ACL entries on the specified object.

ObjectAccessControl
patch(string $bucket, string $object, string $entity, ObjectAccessControl $postBody, array $optParams = [])

Patches an ACL entry on the specified object. (objectAccessControls.patch)

ObjectAccessControl
update(string $bucket, string $object, string $entity, ObjectAccessControl $postBody, array $optParams = [])

Updates an ACL entry on the specified object. (objectAccessControls.update)

Details

at line 52
delete(string $bucket, string $object, string $entity, array $optParams = [])

Permanently deletes the ACL entry for the specified entity on the specified object. (objectAccessControls.delete)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string $entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array $optParams

Optional parameters.

Exceptions

Exception

at line 78
ObjectAccessControl get(string $bucket, string $object, string $entity, array $optParams = [])

Returns the ACL entry for the specified entity on the specified object.

(objectAccessControls.get)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string $entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array $optParams

Optional parameters.

Return Value

ObjectAccessControl

Exceptions

Exception

at line 102
ObjectAccessControl insert(string $bucket, string $object, ObjectAccessControl $postBody, array $optParams = [])

Creates a new ACL entry on the specified object.

(objectAccessControls.insert)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
ObjectAccessControl $postBody
array $optParams

Optional parameters.

Return Value

ObjectAccessControl

Exceptions

Exception

at line 125
ObjectAccessControls listObjectAccessControls(string $bucket, string $object, array $optParams = [])

Retrieves ACL entries on the specified object.

(objectAccessControls.listObjectAccessControls)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
array $optParams

Optional parameters.

Return Value

ObjectAccessControls

Exceptions

Exception

at line 151
ObjectAccessControl patch(string $bucket, string $object, string $entity, ObjectAccessControl $postBody, array $optParams = [])

Patches an ACL entry on the specified object. (objectAccessControls.patch)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string $entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
ObjectAccessControl $postBody
array $optParams

Optional parameters.

Return Value

ObjectAccessControl

Exceptions

Exception

at line 177
ObjectAccessControl update(string $bucket, string $object, string $entity, ObjectAccessControl $postBody, array $optParams = [])

Updates an ACL entry on the specified object. (objectAccessControls.update)

Parameters

string $bucket

Name of a bucket.
string $object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string $entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
ObjectAccessControl $postBody
array $optParams

Optional parameters.

Return Value

ObjectAccessControl

Exceptions

Exception