Class: Google::Apis::DataflowV1b3::CounterStructuredName

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

Identifies a counter within a per-job namespace. Counters whose structured names are the same get merged into a single value for the job.

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) ⇒ CounterStructuredName

Returns a new instance of CounterStructuredName



485
486
487
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 485

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

Instance Attribute Details

#component_step_name ⇒ String

Name of the optimized step being executed by the workers. Corresponds to the JSON property componentStepName

Returns:

  • (String) 


428
429
430
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 428

def component_step_name
  @component_step_name
end

#execution_step_name ⇒ String

Name of the stage. An execution step contains multiple component steps. Corresponds to the JSON property executionStepName

Returns:

  • (String) 


433
434
435
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 433

def execution_step_name
  @execution_step_name
end

#input_index ⇒ Fixnum

Index of an input collection that's being read from/written to as a side input. The index identifies a step's side inputs starting by 1 (e.g. the first side input has input_index 1, the third has input_index 3). Side inputs are identified by a pair of (original_step_name, input_index). This field helps uniquely identify them. Corresponds to the JSON property inputIndex

Returns:

  • (Fixnum) 


443
444
445
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 443

def input_index
  @input_index
end

#name ⇒ String

Counter name. Not necessarily globally-unique, but unique within the context of the other fields. Required. Corresponds to the JSON property name

Returns:

  • (String) 


450
451
452
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 450

def name
  @name
end

#origin ⇒ String

One of the standard Origins defined above. Corresponds to the JSON property origin

Returns:

  • (String) 


455
456
457
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 455

def origin
  @origin
end

#origin_namespace ⇒ String

A string containing a more specific namespace of the counter's origin. Corresponds to the JSON property originNamespace

Returns:

  • (String) 


460
461
462
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 460

def origin_namespace
  @origin_namespace
end

#original_requesting_step_name ⇒ String

The step name requesting an operation, such as GBK. I.e. the ParDo causing a read/write from shuffle to occur, or a read from side inputs. Corresponds to the JSON property originalRequestingStepName

Returns:

  • (String) 


467
468
469
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 467

def original_requesting_step_name
  @original_requesting_step_name
end

#original_step_name ⇒ String

System generated name of the original step in the user's graph, before optimization. Corresponds to the JSON property originalStepName

Returns:

  • (String) 


473
474
475
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 473

def original_step_name
  @original_step_name
end

#portion ⇒ String

Portion of this counter, either key or value. Corresponds to the JSON property portion

Returns:

  • (String) 


478
479
480
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 478

def portion
  @portion
end

#worker_id ⇒ String

ID of a particular worker. Corresponds to the JSON property workerId

Returns:

  • (String) 


483
484
485
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 483

def worker_id
  @worker_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 490

def update!(**args)
  @component_step_name = args[:component_step_name] if args.key?(:component_step_name)
  @execution_step_name = args[:execution_step_name] if args.key?(:execution_step_name)
  @input_index = args[:input_index] if args.key?(:input_index)
  @name = args[:name] if args.key?(:name)
  @origin = args[:origin] if args.key?(:origin)
  @origin_namespace = args[:origin_namespace] if args.key?(:origin_namespace)
  @original_requesting_step_name = args[:original_requesting_step_name] if args.key?(:original_requesting_step_name)
  @original_step_name = args[:original_step_name] if args.key?(:original_step_name)
  @portion = args[:portion] if args.key?(:portion)
  @worker_id = args[:worker_id] if args.key?(:worker_id)
end