Class: Google::Cloud::VisionAI::V1::AnalyzerDefinition

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 an Analyzer.

An analyzer processes data from its input streams using the logic defined in the Operator that it represents. Of course, it produces data for the output streams declared in the Operator.

Defined Under Namespace

Classes: AttrsEntry, DebugOptions, OperatorOption, StreamInput

Instance Attribute Summary collapse

Instance Attribute Details

#analyzer ⇒ ::String

Returns The name of this analyzer.

Tentatively [a-z][a-z0-9](_[a-z0-9]+).

Returns:

  • (::String) —

    The name of this analyzer.

    Tentatively [a-z][a-z0-9](_[a-z0-9]+).



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#attrs ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::AttributeValue}

Returns The attribute values that this analyzer applies to the operator.

Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::AttributeValue}) —

    The attribute values that this analyzer applies to the operator.

    Supply a mapping between the attribute names and the actual value you wish to apply. If an attribute name is omitted, then it will take a preconfigured default value.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#debug_options ⇒ ::Google::Cloud::VisionAI::V1::AnalyzerDefinition::DebugOptions

Returns Debug options.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#inputs ⇒ ::Array<::Google::Cloud::VisionAI::V1::AnalyzerDefinition::StreamInput>

Returns Input streams.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operator ⇒ ::String

Returns The name of the operator that this analyzer runs.

Must match the name of a supported operator.

Returns:

  • (::String) —

    The name of the operator that this analyzer runs.

    Must match the name of a supported operator.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#operator_option ⇒ ::Google::Cloud::VisionAI::V1::AnalyzerDefinition::OperatorOption

Returns Operator option.

Returns:



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'proto_docs/google/cloud/visionai/v1/lva.rb', line 216

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

  # The inputs to this analyzer.
  #
  # We accept input name references of the following form:
  # <analyzer-name>:<output-argument-name>
  #
  # Example:
  #
  # Suppose you had an operator named "SomeOp" that has 2 output
  # arguments, the first of which is named "foo" and the second of which is
  # named "bar", and an operator named "MyOp" that accepts 2 inputs.
  #
  # Also suppose that there is an analyzer named "some-analyzer" that is
  # running "SomeOp" and another analyzer named "my-analyzer" running "MyOp".
  #
  # To indicate that "my-analyzer" is to consume "some-analyzer"'s "foo"
  # output as its first input and "some-analyzer"'s "bar" output as its
  # second input, you can set this field to the following:
  # input = ["some-analyzer:foo", "some-analyzer:bar"]
  # @!attribute [rw] input
  #   @return [::String]
  #     The name of the stream input (as discussed above).
  class StreamInput
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Options available for debugging purposes only.
  # @!attribute [rw] environment_variables
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Environment variables.
  class DebugOptions
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class EnvironmentVariablesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Option related to the operator.
  # @!attribute [rw] tag
  #   @return [::String]
  #     Tag of the operator.
  # @!attribute [rw] registry
  #   @return [::String]
  #     Registry of the operator. e.g. public, dev.
  class OperatorOption
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::VisionAI::V1::AttributeValue]
  class AttrsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end