Documentation

Google_Service_Storage_StorageObject extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$bucket  : mixed
$cacheControl  : mixed
$componentCount  : mixed
$contentDisposition  : mixed
$contentEncoding  : mixed
$contentLanguage  : mixed
$contentType  : mixed
$crc32c  : mixed
$customTime  : mixed
$etag  : mixed
$eventBasedHold  : mixed
$generation  : mixed
$id  : mixed
$kind  : mixed
$kmsKeyName  : mixed
$md5Hash  : mixed
$mediaLink  : mixed
$metadata  : mixed
$metageneration  : mixed
$name  : mixed
$retentionExpirationTime  : mixed
$selfLink  : mixed
$size  : mixed
$storageClass  : mixed
$temporaryHold  : mixed
$timeCreated  : mixed
$timeDeleted  : mixed
$timeStorageClassUpdated  : mixed
$updated  : mixed
$aclDataType  : mixed
$aclType  : mixed
$collection_key  : mixed
$customerEncryptionDataType  : mixed
$customerEncryptionType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$ownerDataType  : mixed
$ownerType  : mixed
$processed  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getAcl()  : Google_Service_Storage_ObjectAccessControl
getBucket()  : mixed
getCacheControl()  : mixed
getComponentCount()  : mixed
getContentDisposition()  : mixed
getContentEncoding()  : mixed
getContentLanguage()  : mixed
getContentType()  : mixed
getCrc32c()  : mixed
getCustomerEncryption()  : Google_Service_Storage_StorageObjectCustomerEncryption
getCustomTime()  : mixed
getEtag()  : mixed
getEventBasedHold()  : mixed
getGeneration()  : mixed
getId()  : mixed
getKind()  : mixed
getKmsKeyName()  : mixed
getMd5Hash()  : mixed
getMediaLink()  : mixed
getMetadata()  : mixed
getMetageneration()  : mixed
getName()  : mixed
getOwner()  : Google_Service_Storage_StorageObjectOwner
getRetentionExpirationTime()  : mixed
getSelfLink()  : mixed
getSize()  : mixed
getStorageClass()  : mixed
getTemporaryHold()  : mixed
getTimeCreated()  : mixed
getTimeDeleted()  : mixed
getTimeStorageClassUpdated()  : mixed
getUpdated()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAcl()  : mixed
setBucket()  : mixed
setCacheControl()  : mixed
setComponentCount()  : mixed
setContentDisposition()  : mixed
setContentEncoding()  : mixed
setContentLanguage()  : mixed
setContentType()  : mixed
setCrc32c()  : mixed
setCustomerEncryption()  : mixed
setCustomTime()  : mixed
setEtag()  : mixed
setEventBasedHold()  : mixed
setGeneration()  : mixed
setId()  : mixed
setKind()  : mixed
setKmsKeyName()  : mixed
setMd5Hash()  : mixed
setMediaLink()  : mixed
setMetadata()  : mixed
setMetageneration()  : mixed
setName()  : mixed
setOwner()  : mixed
setRetentionExpirationTime()  : mixed
setSelfLink()  : mixed
setSize()  : mixed
setStorageClass()  : mixed
setTemporaryHold()  : mixed
setTimeCreated()  : mixed
setTimeDeleted()  : mixed
setTimeStorageClassUpdated()  : mixed
setUpdated()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$retentionExpirationTime

public mixed $retentionExpirationTime

$timeStorageClassUpdated

public mixed $timeStorageClassUpdated

$aclType

protected mixed $aclType = 'Google_Service_Storage_ObjectAccessControl'

$customerEncryptionDataType

protected mixed $customerEncryptionDataType = ''

$customerEncryptionType

protected mixed $customerEncryptionType = 'Google_Service_Storage_StorageObjectCustomerEncryption'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$ownerType

protected mixed $ownerType = 'Google_Service_Storage_StorageObjectOwner'

$processed

protected mixed $processed = array()

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getBucket()

public getBucket() : mixed
Return values
mixed —

getCacheControl()

public getCacheControl() : mixed
Return values
mixed —

getComponentCount()

public getComponentCount() : mixed
Return values
mixed —

getContentDisposition()

public getContentDisposition() : mixed
Return values
mixed —

getContentEncoding()

public getContentEncoding() : mixed
Return values
mixed —

getContentLanguage()

public getContentLanguage() : mixed
Return values
mixed —

getContentType()

public getContentType() : mixed
Return values
mixed —

getCrc32c()

public getCrc32c() : mixed
Return values
mixed —

getCustomTime()

public getCustomTime() : mixed
Return values
mixed —

getEventBasedHold()

public getEventBasedHold() : mixed
Return values
mixed —

getGeneration()

public getGeneration() : mixed
Return values
mixed —

getKmsKeyName()

public getKmsKeyName() : mixed
Return values
mixed —

getMd5Hash()

public getMd5Hash() : mixed
Return values
mixed —

getMediaLink()

public getMediaLink() : mixed
Return values
mixed —

getMetadata()

public getMetadata() : mixed
Return values
mixed —

getMetageneration()

public getMetageneration() : mixed
Return values
mixed —

getRetentionExpirationTime()

public getRetentionExpirationTime() : mixed
Return values
mixed —

getSelfLink()

public getSelfLink() : mixed
Return values
mixed —

getStorageClass()

public getStorageClass() : mixed
Return values
mixed —

getTemporaryHold()

public getTemporaryHold() : mixed
Return values
mixed —

getTimeCreated()

public getTimeCreated() : mixed
Return values
mixed —

getTimeDeleted()

public getTimeDeleted() : mixed
Return values
mixed —

getTimeStorageClassUpdated()

public getTimeStorageClassUpdated() : mixed
Return values
mixed —

getUpdated()

public getUpdated() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setAcl()

public setAcl(mixed $acl) : mixed
Parameters
$acl : mixed
Return values
mixed —

setBucket()

public setBucket(mixed $bucket) : mixed
Parameters
$bucket : mixed
Return values
mixed —

setCacheControl()

public setCacheControl(mixed $cacheControl) : mixed
Parameters
$cacheControl : mixed
Return values
mixed —

setComponentCount()

public setComponentCount(mixed $componentCount) : mixed
Parameters
$componentCount : mixed
Return values
mixed —

setContentDisposition()

public setContentDisposition(mixed $contentDisposition) : mixed
Parameters
$contentDisposition : mixed
Return values
mixed —

setContentEncoding()

public setContentEncoding(mixed $contentEncoding) : mixed
Parameters
$contentEncoding : mixed
Return values
mixed —

setContentLanguage()

public setContentLanguage(mixed $contentLanguage) : mixed
Parameters
$contentLanguage : mixed
Return values
mixed —

setContentType()

public setContentType(mixed $contentType) : mixed
Parameters
$contentType : mixed
Return values
mixed —

setCrc32c()

public setCrc32c(mixed $crc32c) : mixed
Parameters
$crc32c : mixed
Return values
mixed —

setCustomTime()

public setCustomTime(mixed $customTime) : mixed
Parameters
$customTime : mixed
Return values
mixed —

setEtag()

public setEtag(mixed $etag) : mixed
Parameters
$etag : mixed
Return values
mixed —

setEventBasedHold()

public setEventBasedHold(mixed $eventBasedHold) : mixed
Parameters
$eventBasedHold : mixed
Return values
mixed —

setGeneration()

public setGeneration(mixed $generation) : mixed
Parameters
$generation : mixed
Return values
mixed —

setId()

public setId(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed —

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed —

setKmsKeyName()

public setKmsKeyName(mixed $kmsKeyName) : mixed
Parameters
$kmsKeyName : mixed
Return values
mixed —

setMd5Hash()

public setMd5Hash(mixed $md5Hash) : mixed
Parameters
$md5Hash : mixed
Return values
mixed —

setMediaLink()

public setMediaLink(mixed $mediaLink) : mixed
Parameters
$mediaLink : mixed
Return values
mixed —

setMetadata()

public setMetadata(mixed $metadata) : mixed
Parameters
$metadata : mixed
Return values
mixed —

setMetageneration()

public setMetageneration(mixed $metageneration) : mixed
Parameters
$metageneration : mixed
Return values
mixed —

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

setRetentionExpirationTime()

public setRetentionExpirationTime(mixed $retentionExpirationTime) : mixed
Parameters
$retentionExpirationTime : mixed
Return values
mixed —

setSelfLink()

public setSelfLink(mixed $selfLink) : mixed
Parameters
$selfLink : mixed
Return values
mixed —

setSize()

public setSize(mixed $size) : mixed
Parameters
$size : mixed
Return values
mixed —

setStorageClass()

public setStorageClass(mixed $storageClass) : mixed
Parameters
$storageClass : mixed
Return values
mixed —

setTemporaryHold()

public setTemporaryHold(mixed $temporaryHold) : mixed
Parameters
$temporaryHold : mixed
Return values
mixed —

setTimeCreated()

public setTimeCreated(mixed $timeCreated) : mixed
Parameters
$timeCreated : mixed
Return values
mixed —

setTimeDeleted()

public setTimeDeleted(mixed $timeDeleted) : mixed
Parameters
$timeDeleted : mixed
Return values
mixed —

setTimeStorageClassUpdated()

public setTimeStorageClassUpdated(mixed $timeStorageClassUpdated) : mixed
Parameters
$timeStorageClassUpdated : mixed
Return values
mixed —

setUpdated()

public setUpdated(mixed $updated) : mixed
Parameters
$updated : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results