Class: Google::Apis::DataflowV1b3::CounterUpdate

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

An update to a Counter sent from a worker.

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

Returns a new instance of CounterUpdate.



725
726
727
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 725

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

Instance Attribute Details

#boolean ⇒ Boolean Also known as: boolean?

Boolean value for And, Or. Corresponds to the JSON property boolean

Returns:

  • (Boolean) 


644
645
646
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 644

def boolean
  @boolean
end

#cumulative ⇒ Boolean Also known as: cumulative?

True if this counter is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this counter is reported as a delta. Corresponds to the JSON property cumulative

Returns:

  • (Boolean) 


653
654
655
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 653

def cumulative
  @cumulative
end

#distribution ⇒ Google::Apis::DataflowV1b3::DistributionUpdate

A metric value representing a distribution. Corresponds to the JSON property distribution

Returns:



659
660
661
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 659

def distribution
  @distribution
end

#floating_point ⇒ Float

Floating point value for Sum, Max, Min. Corresponds to the JSON property floatingPoint

Returns:

  • (Float) 


664
665
666
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 664

def floating_point
  @floating_point
end

#floating_point_list ⇒ Google::Apis::DataflowV1b3::FloatingPointList

A metric value representing a list of floating point numbers. Corresponds to the JSON property floatingPointList

Returns:



669
670
671
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 669

def floating_point_list
  @floating_point_list
end

#floating_point_mean ⇒ Google::Apis::DataflowV1b3::FloatingPointMean

A representation of a floating point mean metric contribution. Corresponds to the JSON property floatingPointMean

Returns:



674
675
676
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 674

def floating_point_mean
  @floating_point_mean
end

#integer ⇒ Google::Apis::DataflowV1b3::SplitInt64

A representation of an int64, n, that is immune to precision loss when encoded in JSON. Corresponds to the JSON property integer

Returns:



680
681
682
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 680

def integer
  @integer
end

#integer_gauge ⇒ Google::Apis::DataflowV1b3::IntegerGauge

A metric value representing temporal values of a variable. Corresponds to the JSON property integerGauge

Returns:



685
686
687
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 685

def integer_gauge
  @integer_gauge
end

#integer_list ⇒ Google::Apis::DataflowV1b3::IntegerList

A metric value representing a list of integers. Corresponds to the JSON property integerList

Returns:



690
691
692
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 690

def integer_list
  @integer_list
end

#integer_mean ⇒ Google::Apis::DataflowV1b3::IntegerMean

A representation of an integer mean metric contribution. Corresponds to the JSON property integerMean

Returns:



695
696
697
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 695

def integer_mean
  @integer_mean
end

#internal ⇒ Object

Value for internally-defined counters used by the Dataflow service. Corresponds to the JSON property internal

Returns:

  • (Object) 


700
701
702
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 700

def internal
  @internal
end

#name_and_kind ⇒ Google::Apis::DataflowV1b3::NameAndKind

Basic metadata about a counter. Corresponds to the JSON property nameAndKind

Returns:



705
706
707
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 705

def name_and_kind
  @name_and_kind
end

#short_id ⇒ Fixnum

The service-generated short identifier for this counter. The short_id -> (name, metadata) mapping is constant for the lifetime of a job. Corresponds to the JSON property shortId

Returns:

  • (Fixnum) 


712
713
714
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 712

def short_id
  @short_id
end

#string_list ⇒ Google::Apis::DataflowV1b3::StringList

A metric value representing a list of strings. Corresponds to the JSON property stringList

Returns:



717
718
719
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 717

def string_list
  @string_list
end

#structured_name_and_metadata ⇒ Google::Apis::DataflowV1b3::CounterStructuredNameAndMetadata

A single message which encapsulates structured name and metadata for a given counter. Corresponds to the JSON property structuredNameAndMetadata

Returns:



723
724
725
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 723

def structured_name_and_metadata
  @structured_name_and_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 730

def update!(**args)
  @boolean = args[:boolean] if args.key?(:boolean)
  @cumulative = args[:cumulative] if args.key?(:cumulative)
  @distribution = args[:distribution] if args.key?(:distribution)
  @floating_point = args[:floating_point] if args.key?(:floating_point)
  @floating_point_list = args[:floating_point_list] if args.key?(:floating_point_list)
  @floating_point_mean = args[:floating_point_mean] if args.key?(:floating_point_mean)
  @integer = args[:integer] if args.key?(:integer)
  @integer_gauge = args[:integer_gauge] if args.key?(:integer_gauge)
  @integer_list = args[:integer_list] if args.key?(:integer_list)
  @integer_mean = args[:integer_mean] if args.key?(:integer_mean)
  @internal = args[:internal] if args.key?(:internal)
  @name_and_kind = args[:name_and_kind] if args.key?(:name_and_kind)
  @short_id = args[:short_id] if args.key?(:short_id)
  @string_list = args[:string_list] if args.key?(:string_list)
  @structured_name_and_metadata = args[:structured_name_and_metadata] if args.key?(:structured_name_and_metadata)
end