Class: Google::Cloud::DocumentAI::V1beta3::ProcessorVersion

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

Overview

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.

Defined Under Namespace

Modules: State Classes: DeprecationInfo

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns The time the processor version was created.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#deprecation_info ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::DeprecationInfo

Returns If set, information about the eventual deprecation of this version.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#display_name ⇒ ::String

Returns The display name of the processor version.

Returns:

  • (::String) —

    The display name of the processor version.



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#document_schema ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentSchema

Returns The schema of the processor version. Describes the output.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#google_managed ⇒ ::Boolean (readonly)

Returns Output only. Denotes that this ProcessorVersion is managed by Google.

Returns:

  • (::Boolean) —

    Output only. Denotes that this ProcessorVersion is managed by Google.



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#kms_key_name ⇒ ::String

Returns The KMS key name used for encryption.

Returns:

  • (::String) —

    The KMS key name used for encryption.



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#kms_key_version_name ⇒ ::String

Returns The KMS key version with which data is encrypted.

Returns:

  • (::String) —

    The KMS key version with which data is encrypted.



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#latest_evaluation ⇒ ::Google::Cloud::DocumentAI::V1beta3::EvaluationReference

Returns The most recently invoked evaluation for the processor version.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#name ⇒ ::String

Returns The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}.

Returns:

  • (::String) —

    The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1beta3::ProcessorVersion::State

Returns The state of the processor version.

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/documentai/v1beta3/processor.rb', line 60

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

  # Information about the upcoming deprecation of this processor version.
  # @!attribute [rw] deprecation_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time at which this processor version will be deprecated.
  # @!attribute [rw] replacement_processor_version
  #   @return [::String]
  #     If set, the processor version that will be used as a replacement.
  class DeprecationInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

    # The processor version is deployed and can be used for processing.
    DEPLOYED = 1

    # The processor version is being deployed.
    DEPLOYING = 2

    # The processor version is not deployed and cannot be used for processing.
    UNDEPLOYED = 3

    # The processor version is being undeployed.
    UNDEPLOYING = 4

    # The processor version is being created.
    CREATING = 5

    # The processor version is being deleted.
    DELETING = 6

    # The processor version failed and is in an indeterminate state.
    FAILED = 7

    # The processor version is being imported.
    IMPORTING = 8
  end
end