Class: Google::Cloud::DocumentAI::V1::Processor

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

Overview

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The time the processor was created.

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#default_processor_version ⇒ ::String

Returns The default processor version.

Returns:

  • (::String) —

    The default processor version.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#display_name ⇒ ::String

Returns The display name of the processor.

Returns:

  • (::String) —

    The display name of the processor.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#kms_key_name ⇒ ::String

Returns The KMS key used for encryption and decryption in CMEK scenarios.

Returns:

  • (::String) —

    The KMS key used for encryption and decryption in CMEK scenarios.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}.

Returns:

  • (::String) —

    Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#process_endpoint ⇒ ::String (readonly)

Returns Output only. Immutable. The http endpoint that can be called to invoke processing.

Returns:

  • (::String) —

    Output only. Immutable. The http endpoint that can be called to invoke processing.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#processor_version_aliases ⇒ ::Array<::Google::Cloud::DocumentAI::V1::ProcessorVersionAlias> (readonly)

Returns Output only. The processor version aliases.

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1::Processor::State (readonly)

Returns Output only. The state of the processor.

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end

#type ⇒ ::String

Returns The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

Returns:

  • (::String) —

    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'proto_docs/google/cloud/documentai/v1/processor.rb', line 168

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

  # The possible states of the processor.
  module State
    # The processor is in an unspecified state.
    STATE_UNSPECIFIED = 0

    # The processor is enabled, i.e., has an enabled version which can
    # currently serve processing requests and all the feature dependencies have
    # been successfully initialized.
    ENABLED = 1

    # The processor is disabled.
    DISABLED = 2

    # The processor is being enabled, will become `ENABLED` if successful.
    ENABLING = 3

    # The processor is being disabled, will become `DISABLED` if successful.
    DISABLING = 4

    # The processor is being created, will become either `ENABLED` (for
    # successful creation) or `FAILED` (for failed ones).
    # Once a processor is in this state, it can then be used for document
    # processing, but the feature dependencies of the processor might not be
    # fully created yet.
    CREATING = 5

    # The processor failed during creation or initialization of feature
    # dependencies. The user should delete the processor and recreate one as
    # all the functionalities of the processor are disabled.
    FAILED = 6

    # The processor is being deleted, will be removed if successful.
    DELETING = 7
  end
end