Documentation

Google_Service_Storage_Resource_Objects extends Google_Service_Resource
in package

Application

The "objects" collection of methods.

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

$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.
compose() : Google_Service_Storage_StorageObject: Concatenates a list of existing objects into a new object in the same bucket.
copy() : Google_Service_Storage_StorageObject: Copies a source object to a destination object. Optionally overrides metadata. (objects.copy)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : mixed: Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
get() : Google_Service_Storage_StorageObject: Retrieves an object or its metadata. (objects.get)
getIamPolicy() : Google_Service_Storage_Policy: Returns an IAM policy for the specified object. (objects.getIamPolicy)
insert() : Google_Service_Storage_StorageObject: Stores a new object and metadata. (objects.insert)
listObjects() : Google_Service_Storage_Objects: Retrieves a list of objects matching the criteria. (objects.listObjects)
patch() : Google_Service_Storage_StorageObject: Patches an object's metadata. (objects.patch)
rewrite() : Google_Service_Storage_RewriteResponse: Rewrites a source object to a destination object. Optionally overrides metadata. (objects.rewrite)
setIamPolicy() : Google_Service_Storage_Policy: Updates an IAM policy for the specified object. (objects.setIamPolicy)
testIamPermissions() : Google_Service_Storage_TestIamPermissionsResponse: Tests a set of permissions on the given object to see which, if any, are held by the caller. (objects.testIamPermissions)
update() : Google_Service_Storage_StorageObject: Updates an object's metadata. (objects.update)
watchAll() : Google_Service_Storage_Channel: Watch for changes on all objects in a bucket. (objects.watchAll)
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 —

compose()

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


    public
                compose(string $destinationBucket, string $destinationObject, Google_Service_Storage_ComposeRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_StorageObject

(objects.compose)

Parameters

$destinationBucket : string: Name of the bucket containing the source objects. The destination object is stored in this bucket.
$destinationObject : string: Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$postBody : Google_Service_Storage_ComposeRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_StorageObject —

copy()

Copies a source object to a destination object. Optionally overrides metadata. (objects.copy)


    public
                copy(string $sourceBucket, string $sourceObject, string $destinationBucket, string $destinationObject, Google_Service_Storage_StorageObject $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_StorageObject

Parameters

$sourceBucket : string: Name of the bucket in which to find the source object.
$sourceObject : string: Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$destinationBucket : string: 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.
$destinationObject : string: Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
$postBody : Google_Service_Storage_StorageObject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_StorageObject —

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()

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.


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

(objects.delete)

Parameters

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

mixed —

get()

Retrieves an object or its metadata. (objects.get)


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

Parameters

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

getIamPolicy()

Returns an IAM policy for the specified object. (objects.getIamPolicy)


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

Parameters

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

insert()

Stores a new object and metadata. (objects.insert)


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

Parameters

$bucket : string: Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
$postBody : Google_Service_Storage_StorageObject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_StorageObject —

listObjects()

Retrieves a list of objects matching the criteria. (objects.listObjects)


    public
                listObjects(string $bucket[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_Objects

Parameters

$bucket : string: Name of the bucket in which to look for objects.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_Objects —

patch()

Patches an object's metadata. (objects.patch)


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

Parameters

$bucket : string: Name of the bucket in which the object resides.
$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_StorageObject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_StorageObject —

rewrite()

Rewrites a source object to a destination object. Optionally overrides metadata. (objects.rewrite)


    public
                rewrite(string $sourceBucket, string $sourceObject, string $destinationBucket, string $destinationObject, Google_Service_Storage_StorageObject $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_RewriteResponse

Parameters

$sourceBucket : string: Name of the bucket in which to find the source object.
$sourceObject : string: Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
$destinationBucket : string: Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
$destinationObject : string: 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.
$postBody : Google_Service_Storage_StorageObject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_RewriteResponse —

setIamPolicy()

Updates an IAM policy for the specified object. (objects.setIamPolicy)


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

Parameters

$bucket : string: Name of the bucket in which the object resides.
$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_Policy
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_Policy —

testIamPermissions()

Tests a set of permissions on the given object to see which, if any, are held by the caller. (objects.testIamPermissions)


    public
                testIamPermissions(string $bucket, string $object, string|array<string|int, mixed> $permissions[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_TestIamPermissionsResponse

Parameters

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

Return values

Google_Service_Storage_TestIamPermissionsResponse —

update()

Updates an object's metadata. (objects.update)


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

Parameters

$bucket : string: Name of the bucket in which the object resides.
$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_StorageObject
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_StorageObject —

watchAll()

Watch for changes on all objects in a bucket. (objects.watchAll)


    public
                watchAll(string $bucket, Google_Service_Storage_Channel $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Storage_Channel

Parameters

$bucket : string: Name of the bucket in which to look for objects.
$postBody : Google_Service_Storage_Channel
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Storage_Channel —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —