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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string | |
setTopic
A pubsub topic, in the form of "pubsub.googleapis.com/topics/
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSubscription
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/
| Returns | |
|---|---|
| Type | Description |
string | |
setSubscription
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDropLateData
Indicates whether the pipeline allows late-arriving data.
| Returns | |
|---|---|
| Type | Description |
bool | |
setDropLateData
Indicates whether the pipeline allows late-arriving data.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrackingSubscription
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
| Returns | |
|---|---|
| Type | Description |
string | |
setTrackingSubscription
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWithAttributes
If true, then the client has requested to get pubsub attributes.
| Returns | |
|---|---|
| Type | Description |
bool | |
setWithAttributes
If true, then the client has requested to get pubsub attributes.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |