Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
Google_Service_Storage_BucketAccessControls_Resource Class Reference

The "bucketAccessControls" collection of methods. More...

Inheritance diagram for Google_Service_Storage_BucketAccessControls_Resource:
Google_Service_Resource

Public Member Functions

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

Protected Member Functions

 convertToArrayAndStripNulls ($o)
 

Detailed Description

The "bucketAccessControls" collection of methods.

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

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_BucketAccessControls_Resource::delete ( $bucket,
$entity,
$optParams = array() )

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

(bucketAccessControls.delete)

Parameters
string$bucketName of a bucket.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array$optParamsOptional parameters.

◆ get()

Google_Service_Storage_BucketAccessControls_Resource::get ( $bucket,
$entity,
$optParams = array() )

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

(bucketAccessControls.get)

Parameters
string$bucketName of a bucket.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
array$optParamsOptional parameters.
Return values
Google_Service_Storage_BucketAccessControl

◆ insert()

Google_Service_Storage_BucketAccessControls_Resource::insert ( $bucket,
Google_Service_Storage_BucketAccessControl $postBody,
$optParams = array() )

Creates a new ACL entry on the specified bucket.

(bucketAccessControls.insert)

Parameters
string$bucketName of a bucket.
Google_BucketAccessControl$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Storage_BucketAccessControl

◆ listBucketAccessControls()

Google_Service_Storage_BucketAccessControls_Resource::listBucketAccessControls ( $bucket,
$optParams = array() )

Retrieves ACL entries on the specified bucket.

(bucketAccessControls.listBucketAccessControls)

Parameters
string$bucketName of a bucket.
array$optParamsOptional parameters.
Return values
Google_Service_Storage_BucketAccessControls

◆ patch()

Google_Service_Storage_BucketAccessControls_Resource::patch ( $bucket,
$entity,
Google_Service_Storage_BucketAccessControl $postBody,
$optParams = array() )

Updates an ACL entry on the specified bucket.

This method supports patch semantics. (bucketAccessControls.patch)

Parameters
string$bucketName of a bucket.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
Google_BucketAccessControl$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Storage_BucketAccessControl

◆ update()

Google_Service_Storage_BucketAccessControls_Resource::update ( $bucket,
$entity,
Google_Service_Storage_BucketAccessControl $postBody,
$optParams = array() )

Updates an ACL entry on the specified bucket.

(bucketAccessControls.update)

Parameters
string$bucketName of a bucket.
string$entityThe entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
Google_BucketAccessControl$postBody
array$optParamsOptional parameters.
Return values
Google_Service_Storage_BucketAccessControl

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