Class: Google::Cloud::VisionAI::V1::OperatorDefinition

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

Overview

Defines the interface of an Operator.

Arguments to an operator are input/output streams that are getting processesed/returned while attributes are fixed configuration parameters.

Defined Under Namespace

Classes: ArgumentDefinition, AttributeDefinition

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Array<::Google::Cloud::VisionAI::V1::OperatorDefinition::AttributeDefinition>

Returns Declares the attributes.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Full description of the operator.

Returns:

  • (::String) —

    Full description of the operator.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_args ⇒ ::Array<::Google::Cloud::VisionAI::V1::OperatorDefinition::ArgumentDefinition>

Returns Declares input arguments.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operator ⇒ ::String

Returns The name of this operator.

Tentatively [A-Z][a-zA-Z0-9]*, e.g., BboxCounter, PetDetector, PetDetector1.

Returns:

  • (::String) —

    The name of this operator.

    Tentatively [A-Z][a-zA-Z0-9]*, e.g., BboxCounter, PetDetector, PetDetector1.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#output_args ⇒ ::Array<::Google::Cloud::VisionAI::V1::OperatorDefinition::ArgumentDefinition>

Returns Declares output arguments.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#resources ⇒ ::Google::Cloud::VisionAI::V1::ResourceSpecification

Returns The resources for running the operator.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#short_description ⇒ ::String

Returns Short description of the operator.

Returns:

  • (::String) —

    Short description of the operator.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 52

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

  # Defines an argument to an operator.
  #
  # Used for both inputs and outputs.
  # @!attribute [rw] argument
  #   @return [::String]
  #     The name of the argument.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., video, audio,
  #     high_fps_frame.
  # @!attribute [rw] type
  #   @return [::String]
  #     The data type of the argument.
  #
  #     This should match the textual representation of a stream/Packet type.
  class ArgumentDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines an attribute of an operator.
  # @!attribute [rw] attribute
  #   @return [::String]
  #     The name of the attribute.
  #
  #     Tentatively [a-z]([_a-z0-9]*[a-z0-9])?, e.g., max_frames_per_video,
  #     resize_height.
  # @!attribute [rw] type
  #   @return [::String]
  #     The type of this attribute.
  #
  #     See attribute_value.proto for possibilities.
  # @!attribute [rw] default_value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  #     The default value for the attribute.
  class AttributeDefinition
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end