Class: Google::Cloud::DocumentAI::V1beta3::Processor

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

Overview

The first-class citizen for DocumentAI. 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:



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    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.



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    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.



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    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/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.

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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    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}



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    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.



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    FAILED = 6

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

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

Returns Output only. The state of the processor.

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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    FAILED = 6

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

#type ⇒ ::String

Returns The processor type.

Returns:

  • (::String) —

    The processor type.



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
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 52

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.
    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.
    CREATING = 5

    # The processor failed during creation.
    FAILED = 6

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