Documentation

Google_Service_Compute_Instance 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.
$canIpForward  : mixed
$cpuPlatform  : mixed
$creationTimestamp  : mixed
$deletionProtection  : mixed
$description  : mixed
$fingerprint  : mixed
$hostname  : mixed
$id  : mixed
$kind  : mixed
$labelFingerprint  : mixed
$labels  : mixed
$machineType  : mixed
$minCpuPlatform  : mixed
$name  : mixed
$privateIpv6GoogleAccess  : mixed
$resourcePolicies  : mixed
$selfLink  : mixed
$startRestricted  : mixed
$status  : mixed
$statusMessage  : mixed
$zone  : mixed
$collection_key  : mixed
$confidentialInstanceConfigDataType  : mixed
$confidentialInstanceConfigType  : mixed
$disksDataType  : mixed
$disksType  : mixed
$displayDeviceDataType  : mixed
$displayDeviceType  : mixed
$guestAcceleratorsDataType  : mixed
$guestAcceleratorsType  : mixed
$internal_gapi_mappings  : mixed
$metadataDataType  : mixed
$metadataType  : mixed
$modelData  : mixed
$networkInterfacesDataType  : mixed
$networkInterfacesType  : mixed
$processed  : mixed
$reservationAffinityDataType  : mixed
$reservationAffinityType  : mixed
$schedulingDataType  : mixed
$schedulingType  : mixed
$serviceAccountsDataType  : mixed
$serviceAccountsType  : mixed
$shieldedInstanceConfigDataType  : mixed
$shieldedInstanceConfigType  : mixed
$shieldedInstanceIntegrityPolicyDataType  : mixed
$shieldedInstanceIntegrityPolicyType  : mixed
$tagsDataType  : mixed
$tagsType  : 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
getCanIpForward()  : mixed
getConfidentialInstanceConfig()  : Google_Service_Compute_ConfidentialInstanceConfig
getCpuPlatform()  : mixed
getCreationTimestamp()  : mixed
getDeletionProtection()  : mixed
getDescription()  : mixed
getDisks()  : Google_Service_Compute_AttachedDisk
getDisplayDevice()  : Google_Service_Compute_DisplayDevice
getFingerprint()  : mixed
getGuestAccelerators()  : Google_Service_Compute_AcceleratorConfig
getHostname()  : mixed
getId()  : mixed
getKind()  : mixed
getLabelFingerprint()  : mixed
getLabels()  : mixed
getMachineType()  : mixed
getMetadata()  : Google_Service_Compute_Metadata
getMinCpuPlatform()  : mixed
getName()  : mixed
getNetworkInterfaces()  : Google_Service_Compute_NetworkInterface
getPrivateIpv6GoogleAccess()  : mixed
getReservationAffinity()  : Google_Service_Compute_ReservationAffinity
getResourcePolicies()  : mixed
getScheduling()  : Google_Service_Compute_Scheduling
getSelfLink()  : mixed
getServiceAccounts()  : Google_Service_Compute_ServiceAccount
getShieldedInstanceConfig()  : Google_Service_Compute_ShieldedInstanceConfig
getShieldedInstanceIntegrityPolicy()  : Google_Service_Compute_ShieldedInstanceIntegrityPolicy
getStartRestricted()  : mixed
getStatus()  : mixed
getStatusMessage()  : mixed
getTags()  : Google_Service_Compute_Tags
getZone()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setCanIpForward()  : mixed
setConfidentialInstanceConfig()  : mixed
setCpuPlatform()  : mixed
setCreationTimestamp()  : mixed
setDeletionProtection()  : mixed
setDescription()  : mixed
setDisks()  : mixed
setDisplayDevice()  : mixed
setFingerprint()  : mixed
setGuestAccelerators()  : mixed
setHostname()  : mixed
setId()  : mixed
setKind()  : mixed
setLabelFingerprint()  : mixed
setLabels()  : mixed
setMachineType()  : mixed
setMetadata()  : mixed
setMinCpuPlatform()  : mixed
setName()  : mixed
setNetworkInterfaces()  : mixed
setPrivateIpv6GoogleAccess()  : mixed
setReservationAffinity()  : mixed
setResourcePolicies()  : mixed
setScheduling()  : mixed
setSelfLink()  : mixed
setServiceAccounts()  : mixed
setShieldedInstanceConfig()  : mixed
setShieldedInstanceIntegrityPolicy()  : mixed
setStartRestricted()  : mixed
setStatus()  : mixed
setStatusMessage()  : mixed
setTags()  : mixed
setZone()  : 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

$canIpForward

public mixed $canIpForward

$creationTimestamp

public mixed $creationTimestamp

$deletionProtection

public mixed $deletionProtection

$labelFingerprint

public mixed $labelFingerprint

$minCpuPlatform

public mixed $minCpuPlatform

$privateIpv6GoogleAccess

public mixed $privateIpv6GoogleAccess

$resourcePolicies

public mixed $resourcePolicies

$startRestricted

public mixed $startRestricted

$statusMessage

public mixed $statusMessage

$collection_key

protected mixed $collection_key = 'serviceAccounts'

$confidentialInstanceConfigDataType

protected mixed $confidentialInstanceConfigDataType = ''

$confidentialInstanceConfigType

protected mixed $confidentialInstanceConfigType = 'Google_Service_Compute_ConfidentialInstanceConfig'

$disksDataType

protected mixed $disksDataType = 'array'

$disksType

protected mixed $disksType = 'Google_Service_Compute_AttachedDisk'

$displayDeviceDataType

protected mixed $displayDeviceDataType = ''

$displayDeviceType

protected mixed $displayDeviceType = 'Google_Service_Compute_DisplayDevice'

$guestAcceleratorsDataType

protected mixed $guestAcceleratorsDataType = 'array'

$guestAcceleratorsType

protected mixed $guestAcceleratorsType = 'Google_Service_Compute_AcceleratorConfig'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$metadataDataType

protected mixed $metadataDataType = ''

$metadataType

protected mixed $metadataType = 'Google_Service_Compute_Metadata'

$modelData

protected mixed $modelData = array()

$networkInterfacesDataType

protected mixed $networkInterfacesDataType = 'array'

$networkInterfacesType

protected mixed $networkInterfacesType = 'Google_Service_Compute_NetworkInterface'

$processed

protected mixed $processed = array()

$reservationAffinityDataType

protected mixed $reservationAffinityDataType = ''

$reservationAffinityType

protected mixed $reservationAffinityType = 'Google_Service_Compute_ReservationAffinity'

$schedulingDataType

protected mixed $schedulingDataType = ''

$schedulingType

protected mixed $schedulingType = 'Google_Service_Compute_Scheduling'

$serviceAccountsDataType

protected mixed $serviceAccountsDataType = 'array'

$serviceAccountsType

protected mixed $serviceAccountsType = 'Google_Service_Compute_ServiceAccount'

$shieldedInstanceConfigDataType

protected mixed $shieldedInstanceConfigDataType = ''

$shieldedInstanceConfigType

protected mixed $shieldedInstanceConfigType = 'Google_Service_Compute_ShieldedInstanceConfig'

$shieldedInstanceIntegrityPolicyDataType

protected mixed $shieldedInstanceIntegrityPolicyDataType = ''

$shieldedInstanceIntegrityPolicyType

protected mixed $shieldedInstanceIntegrityPolicyType = 'Google_Service_Compute_ShieldedInstanceIntegrityPolicy'

$tagsDataType

protected mixed $tagsDataType = ''

$tagsType

protected mixed $tagsType = 'Google_Service_Compute_Tags'

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 —

getCanIpForward()

public getCanIpForward() : mixed
Return values
mixed —

getCpuPlatform()

public getCpuPlatform() : mixed
Return values
mixed —

getCreationTimestamp()

public getCreationTimestamp() : mixed
Return values
mixed —

getDeletionProtection()

public getDeletionProtection() : mixed
Return values
mixed —

getDescription()

public getDescription() : mixed
Return values
mixed —

getFingerprint()

public getFingerprint() : mixed
Return values
mixed —

getHostname()

public getHostname() : mixed
Return values
mixed —

getId()

public getId() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getLabelFingerprint()

public getLabelFingerprint() : mixed
Return values
mixed —

getLabels()

public getLabels() : mixed
Return values
mixed —

getMachineType()

public getMachineType() : mixed
Return values
mixed —

getMinCpuPlatform()

public getMinCpuPlatform() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getPrivateIpv6GoogleAccess()

public getPrivateIpv6GoogleAccess() : mixed
Return values
mixed —

getResourcePolicies()

public getResourcePolicies() : mixed
Return values
mixed —

getSelfLink()

public getSelfLink() : mixed
Return values
mixed —

getStartRestricted()

public getStartRestricted() : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

getStatusMessage()

public getStatusMessage() : mixed
Return values
mixed —

getZone()

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

setCanIpForward()

public setCanIpForward(mixed $canIpForward) : mixed
Parameters
$canIpForward : mixed
Return values
mixed —

setCpuPlatform()

public setCpuPlatform(mixed $cpuPlatform) : mixed
Parameters
$cpuPlatform : mixed
Return values
mixed —

setCreationTimestamp()

public setCreationTimestamp(mixed $creationTimestamp) : mixed
Parameters
$creationTimestamp : mixed
Return values
mixed —

setDeletionProtection()

public setDeletionProtection(mixed $deletionProtection) : mixed
Parameters
$deletionProtection : mixed
Return values
mixed —

setDescription()

public setDescription(mixed $description) : mixed
Parameters
$description : mixed
Return values
mixed —

setDisks()

public setDisks(mixed $disks) : mixed
Parameters
$disks : mixed
Return values
mixed —

setFingerprint()

public setFingerprint(mixed $fingerprint) : mixed
Parameters
$fingerprint : mixed
Return values
mixed —

setGuestAccelerators()

public setGuestAccelerators(mixed $guestAccelerators) : mixed
Parameters
$guestAccelerators : mixed
Return values
mixed —

setHostname()

public setHostname(mixed $hostname) : mixed
Parameters
$hostname : 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 —

setLabelFingerprint()

public setLabelFingerprint(mixed $labelFingerprint) : mixed
Parameters
$labelFingerprint : mixed
Return values
mixed —

setLabels()

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

setMachineType()

public setMachineType(mixed $machineType) : mixed
Parameters
$machineType : mixed
Return values
mixed —

setMinCpuPlatform()

public setMinCpuPlatform(mixed $minCpuPlatform) : mixed
Parameters
$minCpuPlatform : mixed
Return values
mixed —

setName()

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

setNetworkInterfaces()

public setNetworkInterfaces(mixed $networkInterfaces) : mixed
Parameters
$networkInterfaces : mixed
Return values
mixed —

setPrivateIpv6GoogleAccess()

public setPrivateIpv6GoogleAccess(mixed $privateIpv6GoogleAccess) : mixed
Parameters
$privateIpv6GoogleAccess : mixed
Return values
mixed —

setResourcePolicies()

public setResourcePolicies(mixed $resourcePolicies) : mixed
Parameters
$resourcePolicies : mixed
Return values
mixed —

setSelfLink()

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

setServiceAccounts()

public setServiceAccounts(mixed $serviceAccounts) : mixed
Parameters
$serviceAccounts : mixed
Return values
mixed —

setStartRestricted()

public setStartRestricted(mixed $startRestricted) : mixed
Parameters
$startRestricted : mixed
Return values
mixed —

setStatus()

public setStatus(mixed $status) : mixed
Parameters
$status : mixed
Return values
mixed —

setStatusMessage()

public setStatusMessage(mixed $statusMessage) : mixed
Parameters
$statusMessage : mixed
Return values
mixed —

setZone()

public setZone(mixed $zone) : mixed
Parameters
$zone : 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