Class CreateProcessorRequest (2.25.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
TypeDescription
int

PROCESSOR_FIELD_NUMBER

public static final int PROCESSOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateProcessorRequest getDefaultInstance()
Returns
TypeDescription
CreateProcessorRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateProcessorRequest.Builder newBuilder()
Returns
TypeDescription
CreateProcessorRequest.Builder

newBuilder(CreateProcessorRequest prototype)

public static CreateProcessorRequest.Builder newBuilder(CreateProcessorRequest prototype)
Parameter
NameDescription
prototypeCreateProcessorRequest
Returns
TypeDescription
CreateProcessorRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateProcessorRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateProcessorRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateProcessorRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateProcessorRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateProcessorRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateProcessorRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateProcessorRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateProcessorRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateProcessorRequest> parser()
Returns
TypeDescription
Parser<CreateProcessorRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateProcessorRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateProcessorRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProcessorOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the processor field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateProcessorRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateProcessorRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateProcessorRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateProcessorRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateProcessorRequest.Builder toBuilder()
Returns
TypeDescription
CreateProcessorRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException