target.apidocs.com.google.api.services.dataflow.model.PubsubLocation.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dataflow Show documentation

There is a newer version: v1b4-rev7-1.20.0

Show newest version







PubsubLocation (Dataflow API v1b3-rev20231112-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.dataflow.model
Class PubsubLocation



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.dataflow.model.PubsubLocation













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class PubsubLocation
extends com.google.api.client.json.GenericJson
Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow
 job.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Dataflow API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


PubsubLocation() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


PubsubLocation
clone() 


Boolean
getDropLateData()
Indicates whether the pipeline allows late-arriving data.



Boolean
getDynamicDestinations()
If true, then this location represents dynamic topics.



String
getIdLabel()
If set, contains a pubsub label from which to extract record ids.



String
getSubscription()
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"



String
getTimestampLabel()
If set, contains a pubsub label from which to extract record timestamps.



String
getTopic()
A pubsub topic, in the form of "pubsub.googleapis.com/topics//"



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



Boolean
getWithAttributes()
If true, then the client has requested to get pubsub attributes.



PubsubLocation
set(String fieldName,
   Object value) 


PubsubLocation
setDropLateData(Boolean dropLateData)
Indicates whether the pipeline allows late-arriving data.



PubsubLocation
setDynamicDestinations(Boolean dynamicDestinations)
If true, then this location represents dynamic topics.



PubsubLocation
setIdLabel(String idLabel)
If set, contains a pubsub label from which to extract record ids.



PubsubLocation
setSubscription(String subscription)
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"



PubsubLocation
setTimestampLabel(String timestampLabel)
If set, contains a pubsub label from which to extract record timestamps.



PubsubLocation
setTopic(String topic)
A pubsub topic, in the form of "pubsub.googleapis.com/topics//"



PubsubLocation
setTrackingSubscription(String trackingSubscription)
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps
 for watermark estimation.



PubsubLocation
setWithAttributes(Boolean withAttributes)
If true, then the client has requested to get pubsub attributes.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





PubsubLocation
public PubsubLocation()









Method Detail





getDropLateData
public Boolean getDropLateData()
Indicates whether the pipeline allows late-arriving data.

Returns:
value or null for none








setDropLateData
public PubsubLocation setDropLateData(Boolean dropLateData)
Indicates whether the pipeline allows late-arriving data.

Parameters:
dropLateData - dropLateData or null for none








getDynamicDestinations
public Boolean getDynamicDestinations()
If true, then this location represents dynamic topics.

Returns:
value or null for none








setDynamicDestinations
public PubsubLocation setDynamicDestinations(Boolean dynamicDestinations)
If true, then this location represents dynamic topics.

Parameters:
dynamicDestinations - dynamicDestinations or null for none








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

Returns:
value or null for none








setIdLabel
public PubsubLocation setIdLabel(String idLabel)
If set, contains a pubsub label from which to extract record ids. If left empty, record
 deduplication will be strictly best effort.

Parameters:
idLabel - idLabel or null for none








getSubscription
public String getSubscription()
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"

Returns:
value or null for none








setSubscription
public PubsubLocation setSubscription(String subscription)
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"

Parameters:
subscription - subscription or null for none








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

Returns:
value or null for none








setTimestampLabel
public PubsubLocation setTimestampLabel(String timestampLabel)
If set, contains a pubsub label from which to extract record timestamps. If left empty, record
 timestamps will be generated upon arrival.

Parameters:
timestampLabel - timestampLabel or null for none








getTopic
public String getTopic()
A pubsub topic, in the form of "pubsub.googleapis.com/topics//"

Returns:
value or null for none








setTopic
public PubsubLocation setTopic(String topic)
A pubsub topic, in the form of "pubsub.googleapis.com/topics//"

Parameters:
topic - topic or null for none








getTrackingSubscription
public String getTrackingSubscription()
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps
 for watermark estimation.

Returns:
value or null for none








setTrackingSubscription
public PubsubLocation setTrackingSubscription(String trackingSubscription)
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps
 for watermark estimation.

Parameters:
trackingSubscription - trackingSubscription or null for none








getWithAttributes
public Boolean getWithAttributes()
If true, then the client has requested to get pubsub attributes.

Returns:
value or null for none








setWithAttributes
public PubsubLocation setWithAttributes(Boolean withAttributes)
If true, then the client has requested to get pubsub attributes.

Parameters:
withAttributes - withAttributes or null for none








set
public PubsubLocation set(String fieldName,
                          Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public PubsubLocation clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`PubsubLocation`	`clone()`
`Boolean`	`getDropLateData()` Indicates whether the pipeline allows late-arriving data.
`Boolean`	`getDynamicDestinations()` If true, then this location represents dynamic topics.
`String`	`getIdLabel()` If set, contains a pubsub label from which to extract record ids.
`String`	`getSubscription()` A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
`String`	`getTimestampLabel()` If set, contains a pubsub label from which to extract record timestamps.
`String`	`getTopic()` A pubsub topic, in the form of "pubsub.googleapis.com/topics//"
`String`	`getTrackingSubscription()` If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
`Boolean`	`getWithAttributes()` If true, then the client has requested to get pubsub attributes.
`PubsubLocation`	`set(String fieldName, Object value)`
`PubsubLocation`	`setDropLateData(Boolean dropLateData)` Indicates whether the pipeline allows late-arriving data.
`PubsubLocation`	`setDynamicDestinations(Boolean dynamicDestinations)` If true, then this location represents dynamic topics.
`PubsubLocation`	`setIdLabel(String idLabel)` If set, contains a pubsub label from which to extract record ids.
`PubsubLocation`	`setSubscription(String subscription)` A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
`PubsubLocation`	`setTimestampLabel(String timestampLabel)` If set, contains a pubsub label from which to extract record timestamps.
`PubsubLocation`	`setTopic(String topic)` A pubsub topic, in the form of "pubsub.googleapis.com/topics//"
`PubsubLocation`	`setTrackingSubscription(String trackingSubscription)` If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
`PubsubLocation`	`setWithAttributes(Boolean withAttributes)` If true, then the client has requested to get pubsub attributes.