Class: Google::Cloud::VisionAI::V1::Node

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/platform.rb

Overview

Message describing node object.

Defined Under Namespace

Classes: InputEdge

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns A user friendly display name for the node.

Returns:

  • (::String) —

    A user friendly display name for the node.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Required. A unique name for the node.

Returns:

  • (::String) —

    Required. A unique name for the node.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#node_config ⇒ ::Google::Cloud::VisionAI::V1::ProcessorConfig

Returns Node config.

Returns:



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#output_all_output_channels_to_stream ⇒ ::Boolean

Returns By default, the output of the node will only be available to downstream nodes. To consume the direct output from the application node, the output must be sent to Vision AI Streams at first.

By setting output_all_output_channels_to_stream to true, App Platform will automatically send all the outputs of the current node to Vision AI Stream resources (one stream per output channel). The output stream resource will be created by App Platform automatically during deployment and deleted after application un-deployment. Note that this config applies to all the Application Instances.

The output stream can be override at instance level by configuring the output_resources section of Instance resource. producer_node should be current node, output_resource_binding should be the output channel name (or leave it blank if there is only 1 output channel of the processor) and output_resource should be the target output stream.

Returns:

  • (::Boolean) —

    By default, the output of the node will only be available to downstream nodes. To consume the direct output from the application node, the output must be sent to Vision AI Streams at first.

    By setting output_all_output_channels_to_stream to true, App Platform will automatically send all the outputs of the current node to Vision AI Stream resources (one stream per output channel). The output stream resource will be created by App Platform automatically during deployment and deleted after application un-deployment. Note that this config applies to all the Application Instances.

    The output stream can be override at instance level by configuring the output_resources section of Instance resource. producer_node should be current node, output_resource_binding should be the output channel name (or leave it blank if there is only 1 output channel of the processor) and output_resource should be the target output stream.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parents ⇒ ::Array<::Google::Cloud::VisionAI::V1::Node::InputEdge>

Returns Parent node. Input node should not have parent node. For V1 Alpha1/Beta only media warehouse node can have multiple parents, other types of nodes will only have one parent.

Returns:

  • (::Array<::Google::Cloud::VisionAI::V1::Node::InputEdge>) —

    Parent node. Input node should not have parent node. For V1 Alpha1/Beta only media warehouse node can have multiple parents, other types of nodes will only have one parent.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#processor ⇒ ::String

Returns Processor name refer to the chosen processor resource.

Returns:

  • (::String) —

    Processor name refer to the chosen processor resource.



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
 
# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1022

class Node
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message describing one edge pointing into a node.
  # @!attribute [rw] parent_node
  #   @return [::String]
  #     The name of the parent node.
  # @!attribute [rw] parent_output_channel
  #   @return [::String]
  #     The connected output artifact of the parent node.
  #     It can be omitted if target processor only has 1 output artifact.
  # @!attribute [rw] connected_input_channel
  #   @return [::String]
  #     The connected input channel of the current node's processor.
  #     It can be omitted if target processor only has 1 input channel.
  class InputEdge
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end