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



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

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) 


613
614
615
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 613

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) 


622
623
624
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 622

def cumulative
  @cumulative
end

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

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

Returns:



628
629
630
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 628

def distribution
  @distribution
end

#floating_point ⇒ Float

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

Returns:

  • (Float) 


633
634
635
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 633

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:



638
639
640
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 638

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:



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

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:



649
650
651
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 649

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:



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

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:



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

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:



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

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) 


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

def internal
  @internal
end

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

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

Returns:



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

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) 


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

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:



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

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:



692
693
694
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 692

def structured_name_and_metadata
  @structured_name_and_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 699

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