target.apidocs.com.google.api.services.dataflow.model.SourceMetadata.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







SourceMetadata (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 SourceMetadata



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.SourceMetadata













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




public final class SourceMetadata
extends com.google.api.client.json.GenericJson
Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.

  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


SourceMetadata() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SourceMetadata
clone() 


Long
getEstimatedSizeBytes()
An estimate of the total size (in bytes) of the data that would be read from this source.



Boolean
getInfinite()
Specifies that the size of this source is known to be infinite (this is a streaming source).



Boolean
getProducesSortedKeys()
Whether this source is known to produce key/value pairs with the (encoded) keys in
 lexicographically sorted order.



SourceMetadata
set(String fieldName,
   Object value) 


SourceMetadata
setEstimatedSizeBytes(Long estimatedSizeBytes)
An estimate of the total size (in bytes) of the data that would be read from this source.



SourceMetadata
setInfinite(Boolean infinite)
Specifies that the size of this source is known to be infinite (this is a streaming source).



SourceMetadata
setProducesSortedKeys(Boolean producesSortedKeys)
Whether this source is known to produce key/value pairs with the (encoded) keys in
 lexicographically sorted order.







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





SourceMetadata
public SourceMetadata()









Method Detail





getEstimatedSizeBytes
public Long getEstimatedSizeBytes()
An estimate of the total size (in bytes) of the data that would be read from this source. This
 estimate is in terms of external storage size, before any decompression or other processing
 done by the reader.

Returns:
value or null for none








setEstimatedSizeBytes
public SourceMetadata setEstimatedSizeBytes(Long estimatedSizeBytes)
An estimate of the total size (in bytes) of the data that would be read from this source. This
 estimate is in terms of external storage size, before any decompression or other processing
 done by the reader.

Parameters:
estimatedSizeBytes - estimatedSizeBytes or null for none








getInfinite
public Boolean getInfinite()
Specifies that the size of this source is known to be infinite (this is a streaming source).

Returns:
value or null for none








setInfinite
public SourceMetadata setInfinite(Boolean infinite)
Specifies that the size of this source is known to be infinite (this is a streaming source).

Parameters:
infinite - infinite or null for none








getProducesSortedKeys
public Boolean getProducesSortedKeys()
Whether this source is known to produce key/value pairs with the (encoded) keys in
 lexicographically sorted order.

Returns:
value or null for none








setProducesSortedKeys
public SourceMetadata setProducesSortedKeys(Boolean producesSortedKeys)
Whether this source is known to produce key/value pairs with the (encoded) keys in
 lexicographically sorted order.

Parameters:
producesSortedKeys - producesSortedKeys or null for none








set
public SourceMetadata set(String fieldName,
                          Object value)

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








clone
public SourceMetadata 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
`SourceMetadata`	`clone()`
`Long`	`getEstimatedSizeBytes()` An estimate of the total size (in bytes) of the data that would be read from this source.
`Boolean`	`getInfinite()` Specifies that the size of this source is known to be infinite (this is a streaming source).
`Boolean`	`getProducesSortedKeys()` Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
`SourceMetadata`	`set(String fieldName, Object value)`
`SourceMetadata`	`setEstimatedSizeBytes(Long estimatedSizeBytes)` An estimate of the total size (in bytes) of the data that would be read from this source.
`SourceMetadata`	`setInfinite(Boolean infinite)` Specifies that the size of this source is known to be infinite (this is a streaming source).
`SourceMetadata`	`setProducesSortedKeys(Boolean producesSortedKeys)` Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.