Class: Google::Apis::DataflowV1b3::Position

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dataflow_v1b3/classes.rb,
generated/google/apis/dataflow_v1b3/representations.rb,
generated/google/apis/dataflow_v1b3/representations.rb

Overview

Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Position

Returns a new instance of Position



2740
2741
2742
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2740

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#byte_offset ⇒ Fixnum

Position is a byte offset. Corresponds to the JSON property byteOffset

Returns:

  • (Fixnum) 


2708
2709
2710
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2708

def byte_offset
  @byte_offset
end

#concat_position ⇒ Google::Apis::DataflowV1b3::ConcatPosition

A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources. Corresponds to the JSON property concatPosition

Returns:



2715
2716
2717
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2715

def concat_position
  @concat_position
end

#end ⇒ Boolean Also known as: end?

Position is past all other positions. Also useful for the end position of an unbounded range. Corresponds to the JSON property end

Returns:

  • (Boolean) 


2721
2722
2723
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2721

def end
  @end
end

#key ⇒ String

Position is a string key, ordered lexicographically. Corresponds to the JSON property key

Returns:

  • (String) 


2727
2728
2729
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2727

def key
  @key
end

#record_index ⇒ Fixnum

Position is a record index. Corresponds to the JSON property recordIndex

Returns:

  • (Fixnum) 


2732
2733
2734
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2732

def record_index
  @record_index
end

#shuffle_position ⇒ String

CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding). Corresponds to the JSON property shufflePosition

Returns:

  • (String) 


2738
2739
2740
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2738

def shuffle_position
  @shuffle_position
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2745
2746
2747
2748
2749
2750
2751
2752
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 2745

def update!(**args)
  @byte_offset = args[:byte_offset] if args.key?(:byte_offset)
  @concat_position = args[:concat_position] if args.key?(:concat_position)
  @end = args[:end] if args.key?(:end)
  @key = args[:key] if args.key?(:key)
  @record_index = args[:record_index] if args.key?(:record_index)
  @shuffle_position = args[:shuffle_position] if args.key?(:shuffle_position)
end