Class: Google::Apis::DataflowV1b3::DisplayData

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

Data provided with a pipeline or transform to provide descriptive info.

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

Returns a new instance of DisplayData



1001
1002
1003
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1001

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

Instance Attribute Details

#bool_value ⇒ Boolean Also known as: bool_value?

Contains value if the data is of a boolean type. Corresponds to the JSON property boolValue

Returns:

  • (Boolean) 


933
934
935
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 933

def bool_value
  @bool_value
end

#duration_value ⇒ String

Contains value if the data is of duration type. Corresponds to the JSON property durationValue

Returns:

  • (String) 


939
940
941
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 939

def duration_value
  @duration_value
end

#float_value ⇒ Float

Contains value if the data is of float type. Corresponds to the JSON property floatValue

Returns:

  • (Float) 


944
945
946
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 944

def float_value
  @float_value
end

#int64_value ⇒ Fixnum

Contains value if the data is of int64 type. Corresponds to the JSON property int64Value

Returns:

  • (Fixnum) 


949
950
951
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 949

def int64_value
  @int64_value
end

#java_class_value ⇒ String

Contains value if the data is of java class type. Corresponds to the JSON property javaClassValue

Returns:

  • (String) 


954
955
956
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 954

def java_class_value
  @java_class_value
end

#key ⇒ String

The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system. Corresponds to the JSON property key

Returns:

  • (String) 


961
962
963
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 961

def key
  @key
end

#label ⇒ String

An optional label to display in a dax UI for the element. Corresponds to the JSON property label

Returns:

  • (String) 


966
967
968
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 966

def label
  @label
end

#namespace ⇒ String

The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering. Corresponds to the JSON property namespace

Returns:

  • (String) 


974
975
976
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 974

def namespace
  @namespace
end

#short_str_value ⇒ String

A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip. Corresponds to the JSON property shortStrValue

Returns:

  • (String) 


984
985
986
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 984

def short_str_value
  @short_str_value
end

#str_value ⇒ String

Contains value if the data is of string type. Corresponds to the JSON property strValue

Returns:

  • (String) 


989
990
991
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 989

def str_value
  @str_value
end

#timestamp_value ⇒ String

Contains value if the data is of timestamp type. Corresponds to the JSON property timestampValue

Returns:

  • (String) 


994
995
996
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 994

def timestamp_value
  @timestamp_value
end

#url ⇒ String

An optional full URL. Corresponds to the JSON property url

Returns:

  • (String) 


999
1000
1001
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 999

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 1006

def update!(**args)
  @bool_value = args[:bool_value] if args.key?(:bool_value)
  @duration_value = args[:duration_value] if args.key?(:duration_value)
  @float_value = args[:float_value] if args.key?(:float_value)
  @int64_value = args[:int64_value] if args.key?(:int64_value)
  @java_class_value = args[:java_class_value] if args.key?(:java_class_value)
  @key = args[:key] if args.key?(:key)
  @label = args[:label] if args.key?(:label)
  @namespace = args[:namespace] if args.key?(:namespace)
  @short_str_value = args[:short_str_value] if args.key?(:short_str_value)
  @str_value = args[:str_value] if args.key?(:str_value)
  @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
  @url = args[:url] if args.key?(:url)
end