Class: Google::Cloud::DocumentAI::V1beta3::ProcessorType

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

Overview

A processor type is responsible for performing a certain document understanding task on a certain type of document.

Defined Under Namespace

Classes: LocationInfo

Instance Attribute Summary collapse

Instance Attribute Details

#allow_creation ⇒ ::Boolean

Returns Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.

Returns:

  • (::Boolean) —

    Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#available_locations ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType::LocationInfo>

Returns The locations in which this processor is available.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#category ⇒ ::String

Returns The processor category, used by UI to group processor types.

Returns:

  • (::String) —

    The processor category, used by UI to group processor types.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#launch_stage ⇒ ::Google::Api::LaunchStage

Returns Launch stage of the processor type.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}.

Returns:

  • (::String) —

    The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type}



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sample_document_uris ⇒ ::Array<::String>

Returns A set of Cloud Storage URIs of sample documents for this processor.

Returns:

  • (::Array<::String>) —

    A set of Cloud Storage URIs of sample documents for this processor.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::String

Returns The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

Returns:

  • (::String) —

    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor_type.rb', line 49

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

  # The location information about where the processor is available.
  # @!attribute [rw] location_id
  #   @return [::String]
  #     The location ID. For supported locations, refer to [regional and
  #     multi-regional support](/document-ai/docs/regions).
  class LocationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end