The "objects" collection of methods. More...

Inheritance diagram for Google_Service_Storage_Objects_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.

	compose ($destinationBucket, $destinationObject, Google_Service_Storage_ComposeRequest $postBody, $optParams=array())
	Concatenates a list of existing objects into a new object in the same bucket.

	copy ($sourceBucket, $sourceObject, $destinationBucket, $destinationObject, Google_Service_Storage_StorageObject $postBody, $optParams=array())
	Copies a source object to a destination object.

	delete ($bucket, $object, $optParams=array())
	Deletes an object and its metadata.

	get ($bucket, $object, $optParams=array())
	Retrieves an object or its metadata.

	insert ($bucket, Google_Service_Storage_StorageObject $postBody, $optParams=array())
	Stores a new object and metadata.

	listObjects ($bucket, $optParams=array())
	Retrieves a list of objects matching the criteria.

	patch ($bucket, $object, Google_Service_Storage_StorageObject $postBody, $optParams=array())
	Updates an object's metadata.

	rewrite ($sourceBucket, $sourceObject, $destinationBucket, $destinationObject, Google_Service_Storage_StorageObject $postBody, $optParams=array())
	Rewrites a source object to a destination object.

	update ($bucket, $object, Google_Service_Storage_StorageObject $postBody, $optParams=array())
	Updates an object's metadata.

	watchAll ($bucket, Google_Service_Storage_Channel $postBody, $optParams=array())
	Watch for changes on all objects in a bucket.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "objects" collection of methods.

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

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

◆ compose()

Google_Service_Storage_Objects_Resource::compose	(		$destinationBucket,
			$destinationObject,
		Google_Service_Storage_ComposeRequest	$postBody,
			$optParams = array() )

Concatenates a list of existing objects into a new object in the same bucket.

(objects.compose)

Parameters

string	$destinationBucket	Name of the bucket in which to store the new object.
string	$destinationObject	Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Google_ComposeRequest	$postBody
array	$optParams	Optional parameters.

@opt_param string ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string destinationPredefinedAcl Apply a predefined set of access controls to the destination object.

Return values

Google_Service_Storage_StorageObject

◆ copy()

Google_Service_Storage_Objects_Resource::copy	(		$sourceBucket,
			$sourceObject,
			$destinationBucket,
			$destinationObject,
		Google_Service_Storage_StorageObject	$postBody,
			$optParams = array() )

Copies a source object to a destination object.

Optionally overrides metadata. (objects.copy)

Parameters

string	$sourceBucket	Name of the bucket in which to find the source object.
string	$sourceObject	Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string	$destinationBucket	Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string	$destinationObject	Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
Google_StorageObject	$postBody
array	$optParams	Optional parameters.

@opt_param string ifSourceGenerationNotMatch Makes the operation conditional on whether the source object's generation does not match the given value. @opt_param string ifGenerationNotMatch Makes the operation conditional on whether the destination object's current generation does not match the given value. @opt_param string ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value. @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the destination object's current metageneration matches the given value. @opt_param string sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default). @opt_param string destinationPredefinedAcl Apply a predefined set of access controls to the destination object. @opt_param string ifSourceGenerationMatch Makes the operation conditional on whether the source object's generation matches the given value. @opt_param string ifSourceMetagenerationMatch Makes the operation conditional on whether the source object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the destination object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @opt_param string projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

Return values

Google_Service_Storage_StorageObject

◆ delete()

Google_Service_Storage_Objects_Resource::delete	(	$bucket,
		$object,
		$optParams = array() )

Deletes an object and its metadata.

Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used. (objects.delete)

Parameters

string	$bucket	Name of the bucket in which the object resides.
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.

@opt_param string ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. @opt_param string generation If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.

◆ get()

Google_Service_Storage_Objects_Resource::get	(	$bucket,
		$object,
		$optParams = array() )

Retrieves an object or its metadata.

(objects.get)

Parameters

string	$bucket	Name of the bucket in which the object resides.
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.

@opt_param string ifGenerationNotMatch Makes the operation conditional on whether the object's generation does not match the given value. @opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default). @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the object's generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the object'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_StorageObject

◆ insert()

Google_Service_Storage_Objects_Resource::insert	(		$bucket,
		Google_Service_Storage_StorageObject	$postBody,
			$optParams = array() )

Stores a new object and metadata.

(objects.insert)

Parameters

string	$bucket	Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
Google_StorageObject	$postBody
array	$optParams	Optional parameters.

@opt_param string predefinedAcl Apply a predefined set of access controls to this object. @opt_param string projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. @opt_param string ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string contentEncoding If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded. @opt_param string ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value. @opt_param string name Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

Return values

Google_Service_Storage_StorageObject

◆ listObjects()

Google_Service_Storage_Objects_Resource::listObjects	(		$bucket,
			$optParams = array() )

Retrieves a list of objects matching the criteria.

(objects.listObjects)

Parameters

string	$bucket	Name of the bucket in which to look for objects.
array	$optParams	Optional parameters.

@opt_param string projection Set of properties to return. Defaults to noAcl. @opt_param bool versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @opt_param string prefix Filter results to objects whose names begin with this prefix. @opt_param string maxResults Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. The default value of this parameter is 1,000 items. @opt_param string pageToken A previously-returned page token representing part of the larger set of results to view. @opt_param string delimiter Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

Return values

Google_Service_Storage_Objects

◆ patch()

Google_Service_Storage_Objects_Resource::patch	(		$bucket,
			$object,
		Google_Service_Storage_StorageObject	$postBody,
			$optParams = array() )

Updates an object's metadata.

This method supports patch semantics. (objects.patch)

Parameters

string	$bucket	Name of the bucket in which the object resides.
string	$object	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Google_StorageObject	$postBody
array	$optParams	Optional parameters.

@opt_param string predefinedAcl Apply a predefined set of access controls to this object. @opt_param string ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. @opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default). @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value. @opt_param string projection Set of properties to return. Defaults to full.

Return values

Google_Service_Storage_StorageObject

◆ rewrite()

Google_Service_Storage_Objects_Resource::rewrite	(		$sourceBucket,
			$sourceObject,
			$destinationBucket,
			$destinationObject,
		Google_Service_Storage_StorageObject	$postBody,
			$optParams = array() )

Rewrites a source object to a destination object.

Optionally overrides metadata. (objects.rewrite)

Parameters

string	$sourceBucket	Name of the bucket in which to find the source object.
string	$sourceObject	Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
string	$destinationBucket	Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
string	$destinationObject	Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Google_StorageObject	$postBody
array	$optParams	Optional parameters.

@opt_param string ifSourceGenerationNotMatch Makes the operation conditional on whether the source object's generation does not match the given value. @opt_param string ifGenerationNotMatch Makes the operation conditional on whether the destination object's current generation does not match the given value. @opt_param string rewriteToken Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request. @opt_param string ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value. @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the destination object's current metageneration matches the given value. @opt_param string sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default). @opt_param string destinationPredefinedAcl Apply a predefined set of access controls to the destination object. @opt_param string ifSourceGenerationMatch Makes the operation conditional on whether the source object's generation matches the given value. @opt_param string maxBytesRewrittenPerCall The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid. @opt_param string ifSourceMetagenerationMatch Makes the operation conditional on whether the source object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the destination object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the destination object's current metageneration does not match the given value. @opt_param string projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.

Return values

Google_Service_Storage_RewriteResponse

◆ update()

Google_Service_Storage_Objects_Resource::update	(		$bucket,
			$object,
		Google_Service_Storage_StorageObject	$postBody,
			$optParams = array() )

Updates an object's metadata.

(objects.update)

Parameters

string	$bucket	Name of the bucket in which the object resides.
string	$object	Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
Google_StorageObject	$postBody
array	$optParams	Optional parameters.

@opt_param string predefinedAcl Apply a predefined set of access controls to this object. @opt_param string ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. @opt_param string generation If present, selects a specific revision of this object (as opposed to the latest version, the default). @opt_param string ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value. @opt_param string ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. @opt_param string ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value. @opt_param string projection Set of properties to return. Defaults to full.

Return values

Google_Service_Storage_StorageObject

◆ watchAll()

Google_Service_Storage_Objects_Resource::watchAll	(		$bucket,
		Google_Service_Storage_Channel	$postBody,
			$optParams = array() )

Watch for changes on all objects in a bucket.

(objects.watchAll)

Parameters

string	$bucket	Name of the bucket in which to look for objects.
Google_Channel	$postBody
array	$optParams	Optional parameters.

@opt_param string projection Set of properties to return. Defaults to noAcl. @opt_param bool versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. @opt_param string prefix Filter results to objects whose names begin with this prefix. @opt_param string maxResults Maximum number of items plus prefixes to return. As duplicate prefixes are omitted, fewer total results may be returned than requested. The default value of this parameter is 1,000 items. @opt_param string pageToken A previously-returned page token representing part of the larger set of results to view. @opt_param string delimiter Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

Return values

Google_Service_Storage_Channel

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

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ call()

◆ compose()

◆ copy()

◆ delete()

◆ get()

◆ insert()

◆ listObjects()

◆ patch()

◆ rewrite()

◆ update()

◆ watchAll()