Show / Hide Table of Contents

Class Source

A source that records can be read and decoded from.

Inheritance
object
Source
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataflow.v1b3.Data
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class Source : IDirectResponseSchema

Properties

BaseSpecs

While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).

Declaration
[JsonProperty("baseSpecs")]
public virtual IList<IDictionary<string, object>> BaseSpecs { get; set; }
Property Value
Type Description
IList<IDictionary<string, object>>

Codec

The codec to use to decode data read from the source.

Declaration
[JsonProperty("codec")]
public virtual IDictionary<string, object> Codec { get; set; }
Property Value
Type Description
IDictionary<string, object>

DoesNotNeedSplitting

Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.

Declaration
[JsonProperty("doesNotNeedSplitting")]
public virtual bool? DoesNotNeedSplitting { get; set; }
Property Value
Type Description
bool?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Metadata

Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.

Declaration
[JsonProperty("metadata")]
public virtual SourceMetadata Metadata { get; set; }
Property Value
Type Description
SourceMetadata

Spec

The source to read from, plus its parameters.

Declaration
[JsonProperty("spec")]
public virtual IDictionary<string, object> Spec { get; set; }
Property Value
Type Description
IDictionary<string, object>

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX