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



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

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) 


531
532
533
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 531

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) 


540
541
542
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 540

def cumulative
  @cumulative
end

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

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

Returns:



546
547
548
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 546

def distribution
  @distribution
end

#floating_point ⇒ Float

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

Returns:

  • (Float) 


551
552
553
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 551

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:



556
557
558
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 556

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:



561
562
563
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 561

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:



567
568
569
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 567

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:



572
573
574
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 572

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:



577
578
579
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 577

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:



582
583
584
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 582

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) 


587
588
589
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 587

def internal
  @internal
end

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

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

Returns:



592
593
594
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 592

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) 


599
600
601
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 599

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:



604
605
606
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 604

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:



610
611
612
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 610

def structured_name_and_metadata
  @structured_name_and_metadata
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 617

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