Google Cloud Dataflow V1beta3 Client - Class PubsubLocation (0.3.10)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class PubsubLocation.

Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.

Generated from protobuf message google.dataflow.v1beta3.PubsubLocation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ topic string

A pubsub topic, in the form of "pubsub.googleapis.com/topics/

↳ subscription string

A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/

↳ timestamp_label string

If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.

↳ id_label string

If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.

↳ drop_late_data bool

Indicates whether the pipeline allows late-arriving data.

↳ tracking_subscription string

If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.

↳ with_attributes bool

If true, then the client has requested to get pubsub attributes.

getTopic

A pubsub topic, in the form of "pubsub.googleapis.com/topics/

Returns
TypeDescription
string

setTopic

A pubsub topic, in the form of "pubsub.googleapis.com/topics/

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSubscription

A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/

Returns
TypeDescription
string

setSubscription

A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTimestampLabel

If set, contains a pubsub label from which to extract record timestamps.

If left empty, record timestamps will be generated upon arrival.

Returns
TypeDescription
string

setTimestampLabel

If set, contains a pubsub label from which to extract record timestamps.

If left empty, record timestamps will be generated upon arrival.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIdLabel

If set, contains a pubsub label from which to extract record ids.

If left empty, record deduplication will be strictly best effort.

Returns
TypeDescription
string

setIdLabel

If set, contains a pubsub label from which to extract record ids.

If left empty, record deduplication will be strictly best effort.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDropLateData

Indicates whether the pipeline allows late-arriving data.

Returns
TypeDescription
bool

setDropLateData

Indicates whether the pipeline allows late-arriving data.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getTrackingSubscription

If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.

Returns
TypeDescription
string

setTrackingSubscription

If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWithAttributes

If true, then the client has requested to get pubsub attributes.

Returns
TypeDescription
bool

setWithAttributes

If true, then the client has requested to get pubsub attributes.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this