Google Cloud Support V2 Client - Class SupportEventSubscription (1.7.0)

Reference documentation and code samples for the Google Cloud Support V2 Client class SupportEventSubscription.

A support event subscription.

Generated from protobuf message google.cloud.support.v2.SupportEventSubscription

Namespace

Google \ Cloud \ Support \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the support event subscription.

↳ pub_sub_topic string

Required. The name of the Pub/Sub topic to publish notifications to. Format: projects/{project}/topics/{topic}

↳ state int

Output only. The state of the subscription.

↳ failure_reason int

Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.

↳ create_time Google\Protobuf\Timestamp

Output only. The time at which the subscription was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The time at which the subscription was last updated.

↳ delete_time Google\Protobuf\Timestamp

Output only. The time at which the subscription was deleted.

↳ purge_time Google\Protobuf\Timestamp

Output only. The time at which the subscription will be purged.

getName

Identifier. The resource name of the support event subscription.

Returns
Type Description
string

setName

Identifier. The resource name of the support event subscription.

Parameter
Name Description
var string
Returns
Type Description
$this

getPubSubTopic

Required. The name of the Pub/Sub topic to publish notifications to.

Format: projects/{project}/topics/{topic}

Returns
Type Description
string

setPubSubTopic

Required. The name of the Pub/Sub topic to publish notifications to.

Format: projects/{project}/topics/{topic}

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The state of the subscription.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the subscription.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getFailureReason

Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.

Returns
Type Description
int Enum of type FailureReason.

setFailureReason

Output only. Reason why subscription is failing. State of subscription must be FAILING in order for this to have a value.

Parameter
Name Description
var int

Enum of type FailureReason.

Returns
Type Description
$this

getCreateTime

Output only. The time at which the subscription was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which the subscription was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which the subscription was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which the subscription was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. The time at which the subscription was deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which the subscription was deleted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getPurgeTime

Output only. The time at which the subscription will be purged.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasPurgeTime

clearPurgeTime

setPurgeTime

Output only. The time at which the subscription will be purged.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this