Documentation

Google_Service_Pubsub_Subscription extends Google_Model
in package

This class defines attributes, valid values, and usage which is generated from a given json schema.

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5

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.
$ackDeadlineSeconds  : mixed
$detached  : mixed
$enableMessageOrdering  : mixed
$filter  : mixed
$labels  : mixed
$messageRetentionDuration  : mixed
$name  : mixed
$retainAckedMessages  : mixed
$topic  : mixed
$deadLetterPolicyDataType  : mixed
$deadLetterPolicyType  : mixed
$expirationPolicyDataType  : mixed
$expirationPolicyType  : mixed
$internal_gapi_mappings  : mixed
$modelData  : mixed
$processed  : mixed
$pushConfigDataType  : mixed
$pushConfigType  : mixed
$retryPolicyDataType  : mixed
$retryPolicyType  : 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.
getAckDeadlineSeconds()  : mixed
getDeadLetterPolicy()  : Google_Service_Pubsub_DeadLetterPolicy
getDetached()  : mixed
getEnableMessageOrdering()  : mixed
getExpirationPolicy()  : Google_Service_Pubsub_ExpirationPolicy
getFilter()  : mixed
getLabels()  : mixed
getMessageRetentionDuration()  : mixed
getName()  : mixed
getPushConfig()  : Google_Service_Pubsub_PushConfig
getRetainAckedMessages()  : mixed
getRetryPolicy()  : Google_Service_Pubsub_RetryPolicy
getTopic()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
setAckDeadlineSeconds()  : mixed
setDeadLetterPolicy()  : mixed
setDetached()  : mixed
setEnableMessageOrdering()  : mixed
setExpirationPolicy()  : mixed
setFilter()  : mixed
setLabels()  : mixed
setMessageRetentionDuration()  : mixed
setName()  : mixed
setPushConfig()  : mixed
setRetainAckedMessages()  : mixed
setRetryPolicy()  : mixed
setTopic()  : 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.
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
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

$enableMessageOrdering

public mixed $enableMessageOrdering

$messageRetentionDuration

public mixed $messageRetentionDuration

$deadLetterPolicyDataType

protected mixed $deadLetterPolicyDataType = ''

$deadLetterPolicyType

protected mixed $deadLetterPolicyType = 'Google_Service_Pubsub_DeadLetterPolicy'

$expirationPolicyDataType

protected mixed $expirationPolicyDataType = ''

$expirationPolicyType

protected mixed $expirationPolicyType = 'Google_Service_Pubsub_ExpirationPolicy'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

$pushConfigDataType

protected mixed $pushConfigDataType = ''

$pushConfigType

protected mixed $pushConfigType = 'Google_Service_Pubsub_PushConfig'

$retryPolicyDataType

protected mixed $retryPolicyDataType = ''

$retryPolicyType

protected mixed $retryPolicyType = 'Google_Service_Pubsub_RetryPolicy'

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 —

getAckDeadlineSeconds()

public getAckDeadlineSeconds() : mixed
Return values
mixed —

getDetached()

public getDetached() : mixed
Return values
mixed —

getEnableMessageOrdering()

public getEnableMessageOrdering() : mixed
Return values
mixed —

getFilter()

public getFilter() : mixed
Return values
mixed —

getLabels()

public getLabels() : mixed
Return values
mixed —

getMessageRetentionDuration()

public getMessageRetentionDuration() : mixed
Return values
mixed —

getName()

public getName() : mixed
Return values
mixed —

getRetainAckedMessages()

public getRetainAckedMessages() : mixed
Return values
mixed —

getTopic()

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

setAckDeadlineSeconds()

public setAckDeadlineSeconds(mixed $ackDeadlineSeconds) : mixed
Parameters
$ackDeadlineSeconds : mixed
Return values
mixed —

setDetached()

public setDetached(mixed $detached) : mixed
Parameters
$detached : mixed
Return values
mixed —

setEnableMessageOrdering()

public setEnableMessageOrdering(mixed $enableMessageOrdering) : mixed
Parameters
$enableMessageOrdering : mixed
Return values
mixed —

setFilter()

public setFilter(mixed $filter) : mixed
Parameters
$filter : mixed
Return values
mixed —

setLabels()

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

setMessageRetentionDuration()

public setMessageRetentionDuration(mixed $messageRetentionDuration) : mixed
Parameters
$messageRetentionDuration : mixed
Return values
mixed —

setName()

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

setRetainAckedMessages()

public setRetainAckedMessages(mixed $retainAckedMessages) : mixed
Parameters
$retainAckedMessages : mixed
Return values
mixed —

setTopic()

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

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 —

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