Cloud Scheduler V1beta1 Client - Class PubsubTarget (1.7.1)

Reference documentation and code samples for the Cloud Scheduler V1beta1 Client class PubsubTarget.

Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic.

Generated from protobuf message google.cloud.scheduler.v1beta1.PubsubTarget

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ topic_name string

Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID. The topic must be in the same project as the Cloud Scheduler job.

↳ data string

The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

↳ attributes array|Google\Protobuf\Internal\MapField

Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

getTopicName

Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID.

The topic must be in the same project as the Cloud Scheduler job.

Returns
TypeDescription
string

setTopicName

Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's PublishRequest.name, for example projects/PROJECT_ID/topics/TOPIC_ID.

The topic must be in the same project as the Cloud Scheduler job.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getData

The message payload for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

Returns
TypeDescription
string

setData

The message payload for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAttributes

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAttributes

Attributes for PubsubMessage.

Pubsub message must contain either non-empty data, or at least one attribute.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this