Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_Storage_ObjectAccessControls_Resource Class Reference

The "objectAccessControls" collection of methods. More...

Inheritance diagram for Google_Service_Storage_ObjectAccessControls_Resource:
Google_Service_Resource

Public Member Functions

 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 delete ($bucket, $object, $entity, $optParams=array())
 Permanently deletes the ACL entry for the specified entity on the specified object.
 
 get ($bucket, $object, $entity, $optParams=array())
 Returns the ACL entry for the specified entity on the specified object.
 
 insert ($bucket, $object, Google_Service_Storage_ObjectAccessControl $postBody, $optParams=array())
 Creates a new ACL entry on the specified object.
 
 listObjectAccessControls ($bucket, $object, $optParams=array())
 Retrieves ACL entries on the specified object.
 
 patch ($bucket, $object, $entity, Google_Service_Storage_ObjectAccessControl $postBody, $optParams=array())
 Updates an ACL entry on the specified object.
 
 update ($bucket, $object, $entity, Google_Service_Storage_ObjectAccessControl $postBody, $optParams=array())
 Updates an ACL entry on the specified object.
 

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "objectAccessControls" collection of methods.

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

Member Function Documentation

◆ call()

Google_Service_Resource::call ( $name,
$arguments,
$expected_class = null )
inherited

TODO: This function needs simplifying.

Parameters
$name
$arguments
$expected_class- optional, the expected class name
Return values
Google_Http_Request|expected_class
Exceptions
Google_Exception

◆ delete()

Google_Service_Storage_ObjectAccessControls_Resource::delete ( $bucket,
$object,
$entity,
$optParams = array() )

Permanently deletes the ACL entry for the specified entity on the specified object.

(objectAccessControls.delete)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

◆ get()

Google_Service_Storage_ObjectAccessControls_Resource::get ( $bucket,
$object,
$entity,
$optParams = array() )

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

(objectAccessControls.get)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

Return values
Google_Service_Storage_ObjectAccessControl

◆ insert()

Google_Service_Storage_ObjectAccessControls_Resource::insert ( $bucket,
$object,
Google_Service_Storage_ObjectAccessControl $postBody,
$optParams = array() )

Creates a new ACL entry on the specified object.

(objectAccessControls.insert)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Google_ObjectAccessControl$postBody
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

Return values
Google_Service_Storage_ObjectAccessControl

◆ listObjectAccessControls()

Google_Service_Storage_ObjectAccessControls_Resource::listObjectAccessControls ( $bucket,
$object,
$optParams = array() )

Retrieves ACL entries on the specified object.

(objectAccessControls.listObjectAccessControls)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

Return values
Google_Service_Storage_ObjectAccessControls

◆ patch()

Google_Service_Storage_ObjectAccessControls_Resource::patch ( $bucket,
$object,
$entity,
Google_Service_Storage_ObjectAccessControl $postBody,
$optParams = array() )

Updates an ACL entry on the specified object.

This method supports patch semantics. (objectAccessControls.patch)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
Google_ObjectAccessControl$postBody
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

Return values
Google_Service_Storage_ObjectAccessControl

◆ update()

Google_Service_Storage_ObjectAccessControls_Resource::update ( $bucket,
$object,
$entity,
Google_Service_Storage_ObjectAccessControl $postBody,
$optParams = array() )

Updates an ACL entry on the specified object.

(objectAccessControls.update)

Parameters
string$bucketName of a bucket.
string$objectName of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
Google_ObjectAccessControl$postBody
array$optParamsOptional parameters.

@opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default).

Return values
Google_Service_Storage_ObjectAccessControl

The documentation for this class was generated from the following file: