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



4440
4441
4442
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4440

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) 


4427
4428
4429
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4427

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) 


4372
4373
4374
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4372

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) 


4390
4391
4392
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4390

def float_value
  @float_value
end

#int64_value ⇒ String

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

Returns:

  • (String) 


4377
4378
4379
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4377

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) 


4433
4434
4435
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4433

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) 


4397
4398
4399
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4397

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) 


4412
4413
4414
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4412

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) 


4385
4386
4387
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4385

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) 


4407
4408
4409
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4407

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) 


4438
4439
4440
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4438

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) 


4422
4423
4424
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4422

def timestamp_value
  @timestamp_value
end

#url ⇒ String

An optional full URL. Corresponds to the JSON property url

Returns:

  • (String) 


4417
4418
4419
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4417

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
 
# File 'generated/google/apis/dataflow_v1b3/classes.rb', line 4445

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