Interface ProcessorOrBuilder (2.51.0)

Version 2.51.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 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 interface ProcessorOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

The time the processor was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

The time the processor was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
TimestampOrBuilder

getDefaultProcessorVersion()

public abstract String getDefaultProcessorVersion()

The default processor version.

string default_processor_version = 9 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The defaultProcessorVersion.

getDefaultProcessorVersionBytes()

public abstract ByteString getDefaultProcessorVersionBytes()

The default processor version.

string default_processor_version = 9 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for defaultProcessorVersion.

getDisplayName()

public abstract String getDisplayName()

The display name of the processor.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of the processor.

string display_name = 3;

Returns
Type	Description
ByteString	The bytes for displayName.

getKmsKeyName()

public abstract String getKmsKeyName()

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

string kms_key_name = 8;

Returns
Type	Description
String	The kmsKeyName.

getKmsKeyNameBytes()

public abstract ByteString getKmsKeyNameBytes()

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

string kms_key_name = 8;

Returns
Type	Description
ByteString	The bytes for kmsKeyName.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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.

getProcessorVersionAliases(int index)

public abstract ProcessorVersionAlias getProcessorVersionAliases(int index)

Output only. The processor version aliases.

repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorVersionAlias

getProcessorVersionAliasesCount()

public abstract int getProcessorVersionAliasesCount()

Output only. The processor version aliases.

repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getProcessorVersionAliasesList()

public abstract List<ProcessorVersionAlias> getProcessorVersionAliasesList()

Output only. The processor version aliases.

repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<ProcessorVersionAlias>

getProcessorVersionAliasesOrBuilder(int index)

public abstract ProcessorVersionAliasOrBuilder getProcessorVersionAliasesOrBuilder(int index)

Output only. The processor version aliases.

repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorVersionAliasOrBuilder

getProcessorVersionAliasesOrBuilderList()

public abstract List<? extends ProcessorVersionAliasOrBuilder> getProcessorVersionAliasesOrBuilderList()

Output only. The processor version aliases.

repeated .google.cloud.documentai.v1.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.documentai.v1.ProcessorVersionAliasOrBuilder>

getSatisfiesPzi()

public abstract boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzi.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The satisfiesPzs.

getState()

public abstract 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 abstract 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 abstract String getType()

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

string type = 2;

Returns
Type	Description
String	The type.

getTypeBytes()

public abstract ByteString getTypeBytes()

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

string type = 2;

Returns
Type	Description
ByteString	The bytes for type.

hasCreateTime()

public abstract boolean hasCreateTime()

The time the processor was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type	Description
boolean	Whether the createTime field is set.