Class CreateProcessorRequest (2.51.0)

public final class CreateProcessorRequest extends GeneratedMessageV3 implements CreateProcessorRequestOrBuilder

Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the ProcessorType isn't available in that region, the creation fails.

Protobuf type google.cloud.documentai.v1.CreateProcessorRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PROCESSOR_FIELD_NUMBER

public static final int PROCESSOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateProcessorRequest getDefaultInstance()
Returns
Type Description
CreateProcessorRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateProcessorRequest.Builder newBuilder()
Returns
Type Description
CreateProcessorRequest.Builder

newBuilder(CreateProcessorRequest prototype)

public static CreateProcessorRequest.Builder newBuilder(CreateProcessorRequest prototype)
Parameter
Name Description
prototype CreateProcessorRequest
Returns
Type Description
CreateProcessorRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateProcessorRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateProcessorRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateProcessorRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateProcessorRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateProcessorRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateProcessorRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateProcessorRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateProcessorRequest> parser()
Returns
Type Description
Parser<CreateProcessorRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CreateProcessorRequest getDefaultInstanceForType()
Returns
Type Description
CreateProcessorRequest

getParent()

public String getParent()

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateProcessorRequest> getParserForType()
Returns
Type Description
Parser<CreateProcessorRequest>
Overrides

getProcessor()

public Processor getProcessor()

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

.google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Processor

The processor.

getProcessorOrBuilder()

public ProcessorOrBuilder getProcessorOrBuilder()

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

.google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ProcessorOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasProcessor()

public boolean hasProcessor()

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

.google.cloud.documentai.v1.Processor processor = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the processor field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateProcessorRequest.Builder newBuilderForType()
Returns
Type Description
CreateProcessorRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateProcessorRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateProcessorRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateProcessorRequest.Builder toBuilder()
Returns
Type Description
CreateProcessorRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException