Google_Service_Storage_Buckets_Resource Class Reference

The "buckets" collection of methods. More...

Inheritance diagram for Google_Service_Storage_Buckets_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($bucket, $optParams=array())
	Permanently deletes an empty bucket.
	get ($bucket, $optParams=array())
	Returns metadata for the specified bucket.
	insert ($project, Google_Service_Storage_Bucket $postBody, $optParams=array())
	Creates a new bucket.
	listBuckets ($project, $optParams=array())
	Retrieves a list of buckets for a given project.
	patch ($bucket, Google_Service_Storage_Bucket $postBody, $optParams=array())
	Updates a bucket.
	update ($bucket, Google_Service_Storage_Bucket $postBody, $optParams=array())
	Updates a bucket.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "buckets" collection of methods.

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

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

Permanently deletes an empty bucket.

(buckets.delete)

Parameters

string	$bucket	Name of a bucket.
array	$optParams	Optional parameters.

@opt_param string ifMetagenerationMatch If set, only deletes the bucket if its metageneration matches this value. @opt_param string ifMetagenerationNotMatch If set, only deletes the bucket if its metageneration does not match this value.

get()

Google_Service_Storage_Buckets_Resource::get	(		$bucket,
			$optParams = array() )

Returns metadata for the specified bucket.

(buckets.get)

Parameters

string	$bucket	Name of a bucket.
array	$optParams	Optional parameters.

@opt_param string ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. @opt_param string ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. @opt_param string projection Set of properties to return. Defaults to noAcl.

Return values

Google_Service_Storage_Bucket

insert()

Google_Service_Storage_Buckets_Resource::insert	(		$project,
		Google_Service_Storage_Bucket	$postBody,
			$optParams = array() )

Creates a new bucket.

(buckets.insert)

Parameters

string	$project	A valid API project identifier.
Google_Bucket	$postBody
array	$optParams	Optional parameters.

@opt_param string predefinedAcl Apply a predefined set of access controls to this bucket. @opt_param string projection Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. @opt_param string predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket.

Return values

Google_Service_Storage_Bucket

listBuckets()

Google_Service_Storage_Buckets_Resource::listBuckets	(		$project,
			$optParams = array() )

Retrieves a list of buckets for a given project.

(buckets.listBuckets)

Parameters

string	$project	A valid API project identifier.
array	$optParams	Optional parameters.

@opt_param string pageToken A previously-returned page token representing part of the larger set of results to view. @opt_param string prefix Filter results to buckets whose names begin with this prefix. @opt_param string projection Set of properties to return. Defaults to noAcl. @opt_param string maxResults Maximum number of buckets to return.

Return values

Google_Service_Storage_Buckets

patch()

Google_Service_Storage_Buckets_Resource::patch	(		$bucket,
		Google_Service_Storage_Bucket	$postBody,
			$optParams = array() )

Updates a bucket.

This method supports patch semantics. (buckets.patch)

Parameters

string	$bucket	Name of a bucket.
Google_Bucket	$postBody
array	$optParams	Optional parameters.

@opt_param string projection Set of properties to return. Defaults to full. @opt_param string ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. @opt_param string predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket. @opt_param string predefinedAcl Apply a predefined set of access controls to this bucket. @opt_param string ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.

Return values

Google_Service_Storage_Bucket

update()

Google_Service_Storage_Buckets_Resource::update	(		$bucket,
		Google_Service_Storage_Bucket	$postBody,
			$optParams = array() )

Updates a bucket.

(buckets.update)

Parameters

string	$bucket	Name of a bucket.
Google_Bucket	$postBody
array	$optParams	Optional parameters.

@opt_param string projection Set of properties to return. Defaults to full. @opt_param string ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. @opt_param string predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket. @opt_param string predefinedAcl Apply a predefined set of access controls to this bucket. @opt_param string ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.

Return values

Google_Service_Storage_Bucket

---

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

• lib/google/src/Google/Service/Storage.php