ProcessorOrBuilder (proto-google-cloud-document-ai-v1beta3 0.68.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Processor, Processor.Builder
```
public interface ProcessorOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.google.protobuf.Timestamp`	`getCreateTime()` The time the processor was created.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` The time the processor was created.
`String`	`getDefaultProcessorVersion()` The default processor version.
`com.google.protobuf.ByteString`	`getDefaultProcessorVersionBytes()` The default processor version.
`String`	`getDisplayName()` The display name of the processor.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` The display name of the processor.
`String`	`getKmsKeyName()` The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
`com.google.protobuf.ByteString`	`getKmsKeyNameBytes()` The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`String`	`getProcessEndpoint()` Output only.
`com.google.protobuf.ByteString`	`getProcessEndpointBytes()` Output only.
`ProcessorVersionAlias`	`getProcessorVersionAliases(int index)` Output only.
`int`	`getProcessorVersionAliasesCount()` Output only.
`List<ProcessorVersionAlias>`	`getProcessorVersionAliasesList()` Output only.
`ProcessorVersionAliasOrBuilder`	`getProcessorVersionAliasesOrBuilder(int index)` Output only.
`List<? extends ProcessorVersionAliasOrBuilder>`	`getProcessorVersionAliasesOrBuilderList()` Output only.
`boolean`	`getSatisfiesPzi()` Output only.
`boolean`	`getSatisfiesPzs()` Output only.
`Processor.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`String`	`getType()` The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
`com.google.protobuf.ByteString`	`getTypeBytes()` The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
`boolean`	`hasCreateTime()` The time the processor was created.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getName
```
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:
    
    The name.
  - getNameBytes
```
com.google.protobuf.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:
    
    The bytes for name.
  - getType
```
String getType()
```
```
 The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
 
```
    string type = 2;
    Returns:
    
    The type.
  - getTypeBytes
```
com.google.protobuf.ByteString getTypeBytes()
```
```
 The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
 
```
    string type = 2;
    Returns:
    
    The bytes for type.
  - getDisplayName
```
String getDisplayName()
```
```
 The display name of the processor.
 
```
    string display_name = 3;
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 The display name of the processor.
 
```
    string display_name = 3;
    Returns:
    
    The bytes for displayName.
  - getStateValue
```
int getStateValue()
```
```
 Output only. The state of the processor.
 
```
    .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The enum numeric value on the wire for state.
  - getState
```
Processor.State getState()
```
```
 Output only. The state of the processor.
 
```
    .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The state.
  - getDefaultProcessorVersion
```
String getDefaultProcessorVersion()
```
```
 The default processor version.
 
```
    string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
    Returns:
    
    The defaultProcessorVersion.
  - getDefaultProcessorVersionBytes
```
com.google.protobuf.ByteString getDefaultProcessorVersionBytes()
```
```
 The default processor version.
 
```
    string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
    Returns:
    
    The bytes for defaultProcessorVersion.
  - getProcessorVersionAliasesList
```
List<ProcessorVersionAlias> getProcessorVersionAliasesList()
```
```
 Output only. The processor version aliases.
 
```
    repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getProcessorVersionAliases
```
ProcessorVersionAlias getProcessorVersionAliases(int index)
```
```
 Output only. The processor version aliases.
 
```
    repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getProcessorVersionAliasesCount
```
int getProcessorVersionAliasesCount()
```
```
 Output only. The processor version aliases.
 
```
    repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getProcessorVersionAliasesOrBuilderList
```
List<? extends ProcessorVersionAliasOrBuilder> getProcessorVersionAliasesOrBuilderList()
```
```
 Output only. The processor version aliases.
 
```
    repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getProcessorVersionAliasesOrBuilder
```
ProcessorVersionAliasOrBuilder getProcessorVersionAliasesOrBuilder(int index)
```
```
 Output only. The processor version aliases.
 
```
    repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - getProcessEndpoint
```
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:
    
    The processEndpoint.
  - getProcessEndpointBytes
```
com.google.protobuf.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:
    
    The bytes for processEndpoint.
  - hasCreateTime
```
boolean hasCreateTime()
```
```
 The time the processor was created.
 
```
    .google.protobuf.Timestamp create_time = 7;
    Returns:
    
    Whether the createTime field is set.
  - getCreateTime
```
com.google.protobuf.Timestamp getCreateTime()
```
```
 The time the processor was created.
 
```
    .google.protobuf.Timestamp create_time = 7;
    Returns:
    
    The createTime.
  - getCreateTimeOrBuilder
```
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 The time the processor was created.
 
```
    .google.protobuf.Timestamp create_time = 7;
  - getKmsKeyName
```
String getKmsKeyName()
```
```
 The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
 
```
    string kms_key_name = 8;
    Returns:
    
    The kmsKeyName.
  - getKmsKeyNameBytes
```
com.google.protobuf.ByteString getKmsKeyNameBytes()
```
```
 The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
 
```
    string kms_key_name = 8;
    Returns:
    
    The bytes for kmsKeyName.
  - getSatisfiesPzs
```
boolean getSatisfiesPzs()
```
```
 Output only. Reserved for future use.
 
```
    bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The satisfiesPzs.
  - getSatisfiesPzi
```
boolean getSatisfiesPzi()
```
```
 Output only. Reserved for future use.
 
```
    bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The satisfiesPzi.

Interface ProcessorOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getName

getNameBytes

getType

getTypeBytes

getDisplayName

getDisplayNameBytes

getStateValue

getState

getDefaultProcessorVersion

getDefaultProcessorVersionBytes

getProcessorVersionAliasesList

getProcessorVersionAliases

getProcessorVersionAliasesCount

getProcessorVersionAliasesOrBuilderList

getProcessorVersionAliasesOrBuilder

getProcessEndpoint

getProcessEndpointBytes

hasCreateTime

getCreateTime

getCreateTimeOrBuilder

getKmsKeyName

getKmsKeyNameBytes

getSatisfiesPzs

getSatisfiesPzi