Class: Google::Cloud::Dataflow::V1beta3::DisplayData

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/dataflow/v1beta3/jobs.rb

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#bool_value ⇒ ::Boolean

Returns Contains value if the data is of a boolean type.

Note: The following fields are mutually exclusive: bool_value, str_value, int64_value, float_value, java_class_value, timestamp_value, duration_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Boolean) —

    Contains value if the data is of a boolean type.

    Note: The following fields are mutually exclusive: bool_value, str_value, int64_value, float_value, java_class_value, timestamp_value, duration_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#duration_value ⇒ ::Google::Protobuf::Duration

Returns Contains value if the data is of duration type.

Note: The following fields are mutually exclusive: duration_value, str_value, int64_value, float_value, java_class_value, timestamp_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Duration) —

    Contains value if the data is of duration type.

    Note: The following fields are mutually exclusive: duration_value, str_value, int64_value, float_value, java_class_value, timestamp_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#float_value ⇒ ::Float

Returns Contains value if the data is of float type.

Note: The following fields are mutually exclusive: float_value, str_value, int64_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Float) —

    Contains value if the data is of float type.

    Note: The following fields are mutually exclusive: float_value, str_value, int64_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#int64_value ⇒ ::Integer

Returns Contains value if the data is of int64 type.

Note: The following fields are mutually exclusive: int64_value, str_value, float_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    Contains value if the data is of int64 type.

    Note: The following fields are mutually exclusive: int64_value, str_value, float_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#java_class_value ⇒ ::String

Returns Contains value if the data is of java class type.

Note: The following fields are mutually exclusive: java_class_value, str_value, int64_value, float_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Contains value if the data is of java class type.

    Note: The following fields are mutually exclusive: java_class_value, str_value, int64_value, float_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key ⇒ ::String

Returns 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.

Returns:

  • (::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.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#label ⇒ ::String

Returns An optional label to display in a dax UI for the element.

Returns:

  • (::String) —

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



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#namespace ⇒ ::String

Returns 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.

Returns:

  • (::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.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#short_str_value ⇒ ::String

Returns 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.

Returns:

  • (::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.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#str_value ⇒ ::String

Returns Contains value if the data is of string type.

Note: The following fields are mutually exclusive: str_value, int64_value, float_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Contains value if the data is of string type.

    Note: The following fields are mutually exclusive: str_value, int64_value, float_value, java_class_value, timestamp_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timestamp_value ⇒ ::Google::Protobuf::Timestamp

Returns Contains value if the data is of timestamp type.

Note: The following fields are mutually exclusive: timestamp_value, str_value, int64_value, float_value, java_class_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Contains value if the data is of timestamp type.

    Note: The following fields are mutually exclusive: timestamp_value, str_value, int64_value, float_value, java_class_value, duration_value, bool_value. If a field in that set is populated, all other fields in the set will automatically be cleared.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#url ⇒ ::String

Returns An optional full URL.

Returns:

  • (::String) —

    An optional full URL.



545
546
547
548
 
# File 'proto_docs/google/dataflow/v1beta3/jobs.rb', line 545

class DisplayData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end