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



763
764
765
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 763

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) 


727
728
729
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 727

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) 


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

def cumulative
  @cumulative
end

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

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

Returns:



743
744
745
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 743

def distribution
  @distribution
end

#floating_point ⇒ Float

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

Returns:

  • (Float) 


698
699
700
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 698

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:



755
756
757
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 755

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:



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

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:



761
762
763
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 761

def integer
  @integer
end

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

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

Returns:



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

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:



703
704
705
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 703

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) 


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

def internal
  @internal
end

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

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

Returns:



733
734
735
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 733

def name_and_kind
  @name_and_kind
end

#short_id ⇒ String

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:

  • (String) 


750
751
752
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 750

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:



738
739
740
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 738

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:



688
689
690
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 688

def structured_name_and_metadata
  @structured_name_and_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 768

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