Documentation

Google_Service_Storage_Resource_ObjectAccessControls extends Google_Service_Resource
in package

Application

The "objectAccessControls" collection of methods.

Typical usage is: $storageService = new Google_Service_Storage(...); $objectAccessControls = $storageService->objectAccessControls;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Permanently deletes the ACL entry for the specified entity on the specified object. (objectAccessControls.delete)
get() : Google_Service_Storage_ObjectAccessControl: Returns the ACL entry for the specified entity on the specified object.
insert() : Google_Service_Storage_ObjectAccessControl: Creates a new ACL entry on the specified object.
listObjectAccessControls() : Google_Service_Storage_ObjectAccessControls: Retrieves ACL entries on the specified object.
patch() : Google_Service_Storage_ObjectAccessControl: Patches an ACL entry on the specified object. (objectAccessControls.patch)
update() : Google_Service_Storage_ObjectAccessControl: Updates an ACL entry on the specified object. (objectAccessControls.update)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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


    public
                delete(string $bucket, string $object, string $entity[, array<string|int, mixed> $optParams = array() ]) : mixed

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$entity : string: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

mixed —

get()

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


    public
                get(string $bucket, string $object, string $entity[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

(objectAccessControls.get)

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$entity : string: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_ObjectAccessControl —

insert()

Creates a new ACL entry on the specified object.


    public
                insert(string $bucket, string $object, Google_Service_Storage_ObjectAccessControl $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

(objectAccessControls.insert)

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$postBody : Google_Service_Storage_ObjectAccessControl
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_ObjectAccessControl —

listObjectAccessControls()

Retrieves ACL entries on the specified object.


    public
                listObjectAccessControls(string $bucket, string $object[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControls

(objectAccessControls.listObjectAccessControls)

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_ObjectAccessControls —

patch()

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


    public
                patch(string $bucket, string $object, string $entity, Google_Service_Storage_ObjectAccessControl $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$entity : string: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
$postBody : Google_Service_Storage_ObjectAccessControl
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_ObjectAccessControl —

update()

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


    public
                update(string $bucket, string $object, string $entity, Google_Service_Storage_ObjectAccessControl $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_ObjectAccessControl

Parameters

$bucket : string: Name of a bucket.
$object : string: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$entity : string: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
$postBody : Google_Service_Storage_ObjectAccessControl
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_ObjectAccessControl —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —