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.



3181
3182
3183
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3181

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) 


3149
3150
3151
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3149

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:



3156
3157
3158
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3156

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) 


3162
3163
3164
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3162

def end
  @end
end

#key ⇒ String

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

Returns:

  • (String) 


3168
3169
3170
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3168

def key
  @key
end

#record_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3173
3174
3175
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3173

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) 


3179
3180
3181
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3179

def shuffle_position
  @shuffle_position
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3186
3187
3188
3189
3190
3191
3192
3193
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 3186

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