Documentation

Google_Service_Storage_Bucket 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.
$defaultEventBasedHold  : mixed
$etag  : mixed
$id  : mixed
$kind  : mixed
$labels  : mixed
$location  : mixed
$locationType  : mixed
$metageneration  : mixed
$name  : mixed
$projectNumber  : mixed
$selfLink  : mixed
$storageClass  : mixed
$timeCreated  : mixed
$updated  : mixed
$zoneAffinity  : mixed
$aclDataType  : mixed
$aclType  : mixed
$billingDataType  : mixed
$billingType  : mixed
$collection_key  : mixed
$corsDataType  : mixed
$corsType  : mixed
$defaultObjectAclDataType  : mixed
$defaultObjectAclType  : mixed
$encryptionDataType  : mixed
$encryptionType  : mixed
$iamConfigurationDataType  : mixed
$iamConfigurationType  : mixed
$internal_gapi_mappings  : mixed
$lifecycleDataType  : mixed
$lifecycleType  : mixed
$loggingDataType  : mixed
$loggingType  : mixed
$modelData  : mixed
$ownerDataType  : mixed
$ownerType  : mixed
$processed  : mixed
$retentionPolicyDataType  : mixed
$retentionPolicyType  : mixed
$versioningDataType  : mixed
$versioningType  : mixed
$websiteDataType  : mixed
$websiteType  : 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_BucketAccessControl
getBilling()  : Google_Service_Storage_BucketBilling
getCors()  : Google_Service_Storage_BucketCors
getDefaultEventBasedHold()  : mixed
getDefaultObjectAcl()  : Google_Service_Storage_ObjectAccessControl
getEncryption()  : Google_Service_Storage_BucketEncryption
getEtag()  : mixed
getIamConfiguration()  : Google_Service_Storage_BucketIamConfiguration
getId()  : mixed
getKind()  : mixed
getLabels()  : mixed
getLifecycle()  : Google_Service_Storage_BucketLifecycle
getLocation()  : mixed
getLocationType()  : mixed
getLogging()  : Google_Service_Storage_BucketLogging
getMetageneration()  : mixed
getName()  : mixed
getOwner()  : Google_Service_Storage_BucketOwner
getProjectNumber()  : mixed
getRetentionPolicy()  : Google_Service_Storage_BucketRetentionPolicy
getSelfLink()  : mixed
getStorageClass()  : mixed
getTimeCreated()  : mixed
getUpdated()  : mixed
getVersioning()  : Google_Service_Storage_BucketVersioning
getWebsite()  : Google_Service_Storage_BucketWebsite
getZoneAffinity()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAcl()  : mixed
setBilling()  : mixed
setCors()  : mixed
setDefaultEventBasedHold()  : mixed
setDefaultObjectAcl()  : mixed
setEncryption()  : mixed
setEtag()  : mixed
setIamConfiguration()  : mixed
setId()  : mixed
setKind()  : mixed
setLabels()  : mixed
setLifecycle()  : mixed
setLocation()  : mixed
setLocationType()  : mixed
setLogging()  : mixed
setMetageneration()  : mixed
setName()  : mixed
setOwner()  : mixed
setProjectNumber()  : mixed
setRetentionPolicy()  : mixed
setSelfLink()  : mixed
setStorageClass()  : mixed
setTimeCreated()  : mixed
setUpdated()  : mixed
setVersioning()  : mixed
setWebsite()  : mixed
setZoneAffinity()  : 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

$defaultEventBasedHold

public mixed $defaultEventBasedHold

$location

public mixed $location

$locationType

public mixed $locationType

$metageneration

public mixed $metageneration

$projectNumber

public mixed $projectNumber
public mixed $selfLink

$storageClass

public mixed $storageClass

$timeCreated

public mixed $timeCreated

$zoneAffinity

public mixed $zoneAffinity

$aclDataType

protected mixed $aclDataType = 'array'

$aclType

protected mixed $aclType = 'Google_Service_Storage_BucketAccessControl'

$billingDataType

protected mixed $billingDataType = ''

$billingType

protected mixed $billingType = 'Google_Service_Storage_BucketBilling'

$collection_key

protected mixed $collection_key = 'zoneAffinity'

$corsDataType

protected mixed $corsDataType = 'array'

$corsType

protected mixed $corsType = 'Google_Service_Storage_BucketCors'

$defaultObjectAclDataType

protected mixed $defaultObjectAclDataType = 'array'

$defaultObjectAclType

protected mixed $defaultObjectAclType = 'Google_Service_Storage_ObjectAccessControl'

$encryptionDataType

protected mixed $encryptionDataType = ''

$encryptionType

protected mixed $encryptionType = 'Google_Service_Storage_BucketEncryption'

$iamConfigurationDataType

protected mixed $iamConfigurationDataType = ''

$iamConfigurationType

protected mixed $iamConfigurationType = 'Google_Service_Storage_BucketIamConfiguration'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lifecycleDataType

protected mixed $lifecycleDataType = ''

$lifecycleType

protected mixed $lifecycleType = 'Google_Service_Storage_BucketLifecycle'

$loggingDataType

protected mixed $loggingDataType = ''

$loggingType

protected mixed $loggingType = 'Google_Service_Storage_BucketLogging'

$modelData

protected mixed $modelData = array()

$ownerDataType

protected mixed $ownerDataType = ''

$ownerType

protected mixed $ownerType = 'Google_Service_Storage_BucketOwner'

$processed

protected mixed $processed = array()

$retentionPolicyDataType

protected mixed $retentionPolicyDataType = ''

$retentionPolicyType

protected mixed $retentionPolicyType = 'Google_Service_Storage_BucketRetentionPolicy'

$versioningDataType

protected mixed $versioningDataType = ''

$versioningType

protected mixed $versioningType = 'Google_Service_Storage_BucketVersioning'

$websiteDataType

protected mixed $websiteDataType = ''

$websiteType

protected mixed $websiteType = 'Google_Service_Storage_BucketWebsite'

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

getDefaultEventBasedHold()

public getDefaultEventBasedHold() : mixed
Return values
mixed

getEtag()

public getEtag() : mixed
Return values
mixed

getId()

public getId() : mixed
Return values
mixed

getKind()

public getKind() : mixed
Return values
mixed

getLabels()

public getLabels() : mixed
Return values
mixed

getLocation()

public getLocation() : mixed
Return values
mixed

getLocationType()

public getLocationType() : mixed
Return values
mixed

getMetageneration()

public getMetageneration() : mixed
Return values
mixed

getName()

public getName() : mixed
Return values
mixed

getProjectNumber()

public getProjectNumber() : mixed
Return values
mixed
public getSelfLink() : mixed
Return values
mixed

getStorageClass()

public getStorageClass() : mixed
Return values
mixed

getTimeCreated()

public getTimeCreated() : mixed
Return values
mixed

getUpdated()

public getUpdated() : mixed
Return values
mixed

getZoneAffinity()

public getZoneAffinity() : 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

setCors()

public setCors(mixed $cors) : mixed
Parameters
$cors : mixed
Return values
mixed

setDefaultEventBasedHold()

public setDefaultEventBasedHold(mixed $defaultEventBasedHold) : mixed
Parameters
$defaultEventBasedHold : mixed
Return values
mixed

setDefaultObjectAcl()

public setDefaultObjectAcl(mixed $defaultObjectAcl) : mixed
Parameters
$defaultObjectAcl : mixed
Return values
mixed

setEtag()

public setEtag(mixed $etag) : mixed
Parameters
$etag : 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

setLabels()

public setLabels(mixed $labels) : mixed
Parameters
$labels : mixed
Return values
mixed

setLocation()

public setLocation(mixed $location) : mixed
Parameters
$location : mixed
Return values
mixed

setLocationType()

public setLocationType(mixed $locationType) : mixed
Parameters
$locationType : 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

setProjectNumber()

public setProjectNumber(mixed $projectNumber) : mixed
Parameters
$projectNumber : mixed
Return values
mixed
public setSelfLink(mixed $selfLink) : mixed
Parameters
$selfLink : mixed
Return values
mixed

setStorageClass()

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

setTimeCreated()

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

setUpdated()

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

setZoneAffinity()

public setZoneAffinity(mixed $zoneAffinity) : mixed
Parameters
$zoneAffinity : 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