- 2.52.0 (latest)
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public static final class Processor.Builder extends GeneratedMessageV3.Builder<Processor.Builder> implements ProcessorOrBuilder
The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
Protobuf type google.cloud.documentai.v1.Processor
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Processor.BuilderImplements
ProcessorOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Processor.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Processor.Builder |
build()
public Processor build()
Returns | |
---|---|
Type | Description |
Processor |
buildPartial()
public Processor buildPartial()
Returns | |
---|---|
Type | Description |
Processor |
clear()
public Processor.Builder clear()
Returns | |
---|---|
Type | Description |
Processor.Builder |
clearCreateTime()
public Processor.Builder clearCreateTime()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns | |
---|---|
Type | Description |
Processor.Builder |
clearDefaultProcessorVersion()
public Processor.Builder clearDefaultProcessorVersion()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearDisplayName()
public Processor.Builder clearDisplayName()
The display name of the processor.
string display_name = 3;
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Processor.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Processor.Builder |
clearKmsKeyName()
public Processor.Builder clearKmsKeyName()
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
string kms_key_name = 8;
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearName()
public Processor.Builder clearName()
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Processor.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Processor.Builder |
clearProcessEndpoint()
public Processor.Builder clearProcessEndpoint()
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearState()
public Processor.Builder clearState()
Output only. The state of the processor.
.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clearType()
public Processor.Builder clearType()
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see
FetchProcessorTypes.
string type = 2;
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
clone()
public Processor.Builder clone()
Returns | |
---|---|
Type | Description |
Processor.Builder |
getCreateTime()
public Timestamp getCreateTime()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public Processor getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Processor |
getDefaultProcessorVersion()
public String getDefaultProcessorVersion()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The defaultProcessorVersion. |
getDefaultProcessorVersionBytes()
public ByteString getDefaultProcessorVersionBytes()
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for defaultProcessorVersion. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
The display name of the processor.
string display_name = 3;
Returns | |
---|---|
Type | Description |
String | The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the processor.
string display_name = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for displayName. |
getKmsKeyName()
public String getKmsKeyName()
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
string kms_key_name = 8;
Returns | |
---|---|
Type | Description |
String | The kmsKeyName. |
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
string kms_key_name = 8;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for kmsKeyName. |
getName()
public String getName()
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for name. |
getProcessEndpoint()
public String getProcessEndpoint()
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
String | The processEndpoint. |
getProcessEndpointBytes()
public ByteString getProcessEndpointBytes()
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for processEndpoint. |
getState()
public Processor.State getState()
Output only. The state of the processor.
.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Processor.State | The state. |
getStateValue()
public int getStateValue()
Output only. The state of the processor.
.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for state. |
getType()
public String getType()
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see
FetchProcessorTypes.
string type = 2;
Returns | |
---|---|
Type | Description |
String | The type. |
getTypeBytes()
public ByteString getTypeBytes()
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see
FetchProcessorTypes.
string type = 2;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for type. |
hasCreateTime()
public boolean hasCreateTime()
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Processor.Builder mergeCreateTime(Timestamp value)
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Processor.Builder |
mergeFrom(Processor other)
public Processor.Builder mergeFrom(Processor other)
Parameter | |
---|---|
Name | Description |
other | Processor |
Returns | |
---|---|
Type | Description |
Processor.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Processor.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Processor.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Processor.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Processor.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Processor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Processor.Builder |
setCreateTime(Timestamp value)
public Processor.Builder setCreateTime(Timestamp value)
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Processor.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Processor.Builder setCreateTime(Timestamp.Builder builderForValue)
The time the processor was created.
.google.protobuf.Timestamp create_time = 7;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Processor.Builder |
setDefaultProcessorVersion(String value)
public Processor.Builder setDefaultProcessorVersion(String value)
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The defaultProcessorVersion to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setDefaultProcessorVersionBytes(ByteString value)
public Processor.Builder setDefaultProcessorVersionBytes(ByteString value)
The default processor version.
string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for defaultProcessorVersion to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setDisplayName(String value)
public Processor.Builder setDisplayName(String value)
The display name of the processor.
string display_name = 3;
Parameter | |
---|---|
Name | Description |
value | String The displayName to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public Processor.Builder setDisplayNameBytes(ByteString value)
The display name of the processor.
string display_name = 3;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Processor.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Processor.Builder |
setKmsKeyName(String value)
public Processor.Builder setKmsKeyName(String value)
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
string kms_key_name = 8;
Parameter | |
---|---|
Name | Description |
value | String The kmsKeyName to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setKmsKeyNameBytes(ByteString value)
public Processor.Builder setKmsKeyNameBytes(ByteString value)
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
string kms_key_name = 8;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for kmsKeyName to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setName(String value)
public Processor.Builder setName(String value)
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | String The name to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public Processor.Builder setNameBytes(ByteString value)
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setProcessEndpoint(String value)
public Processor.Builder setProcessEndpoint(String value)
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | String The processEndpoint to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setProcessEndpointBytes(ByteString value)
public Processor.Builder setProcessEndpointBytes(ByteString value)
Output only. Immutable. The http endpoint that can be called to invoke processing.
string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for processEndpoint to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Processor.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Processor.Builder |
setState(Processor.State value)
public Processor.Builder setState(Processor.State value)
Output only. The state of the processor.
.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | Processor.State The state to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setStateValue(int value)
public Processor.Builder setStateValue(int value)
Output only. The state of the processor.
.google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setType(String value)
public Processor.Builder setType(String value)
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see
FetchProcessorTypes.
string type = 2;
Parameter | |
---|---|
Name | Description |
value | String The type to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setTypeBytes(ByteString value)
public Processor.Builder setTypeBytes(ByteString value)
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see
FetchProcessorTypes.
string type = 2;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for type to set. |
Returns | |
---|---|
Type | Description |
Processor.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Processor.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Processor.Builder |