Class GetDocumentRequest (2.41.0)

public final class GetDocumentRequest extends GeneratedMessageV3 implements GetDocumentRequestOrBuilder

Protobuf type google.cloud.documentai.v1beta3.GetDocumentRequest

Static Fields

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_RANGE_FIELD_NUMBER

public static final int PAGE_RANGE_FIELD_NUMBER
Field Value
TypeDescription
int

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GetDocumentRequest getDefaultInstance()
Returns
TypeDescription
GetDocumentRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetDocumentRequest prototype)

public static GetDocumentRequest.Builder newBuilder(GetDocumentRequest prototype)
Parameter
NameDescription
prototypeGetDocumentRequest
Returns
TypeDescription
GetDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDataset()

public String getDataset()

Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset

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

Returns
TypeDescription
String

The dataset.

getDatasetBytes()

public ByteString getDatasetBytes()

Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset

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

Returns
TypeDescription
ByteString

The bytes for dataset.

getDefaultInstanceForType()

public GetDocumentRequest getDefaultInstanceForType()
Returns
TypeDescription
GetDocumentRequest

getDocumentId()

public DocumentId getDocumentId()

Required. Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentId

The documentId.

getDocumentIdOrBuilder()

public DocumentIdOrBuilder getDocumentIdOrBuilder()

Required. Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
DocumentIdOrBuilder

getPageRange()

public DocumentPageRange getPageRange()

List of pages for which the fields specified in the read_mask must be served.

.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;

Returns
TypeDescription
DocumentPageRange

The pageRange.

getPageRangeOrBuilder()

public DocumentPageRangeOrBuilder getPageRangeOrBuilder()

List of pages for which the fields specified in the read_mask must be served.

.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;

Returns
TypeDescription
DocumentPageRangeOrBuilder

getParserForType()

public Parser<GetDocumentRequest> getParserForType()
Returns
TypeDescription
Parser<GetDocumentRequest>
Overrides

getReadMask()

public FieldMask getReadMask()

If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

.google.protobuf.FieldMask read_mask = 3;

Returns
TypeDescription
FieldMask

The readMask.

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

.google.protobuf.FieldMask read_mask = 3;

Returns
TypeDescription
FieldMaskOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDocumentId()

public boolean hasDocumentId()

Required. Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the documentId field is set.

hasPageRange()

public boolean hasPageRange()

List of pages for which the fields specified in the read_mask must be served.

.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;

Returns
TypeDescription
boolean

Whether the pageRange field is set.

hasReadMask()

public boolean hasReadMask()

If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

.google.protobuf.FieldMask read_mask = 3;

Returns
TypeDescription
boolean

Whether the readMask 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 GetDocumentRequest.Builder newBuilderForType()
Returns
TypeDescription
GetDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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