Class GetDocumentRequest (2.80.0)
Version 2.80.0keyboard_arrow_down
public final class GetDocumentRequest extends GeneratedMessageV3 implements GetDocumentRequestOrBuilder
Protobuf type google.cloud.documentai.v1beta3.GetDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATASET_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_ID_FIELD_NUMBER
public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
Type Description
int
PAGE_RANGE_FIELD_NUMBER
public static final int PAGE_RANGE_FIELD_NUMBER
Field Value
Type Description
int
READ_MASK_FIELD_NUMBER
public static final int READ_MASK_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static GetDocumentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static GetDocumentRequest . Builder newBuilder ()
newBuilder(GetDocumentRequest prototype)
public static GetDocumentRequest . Builder newBuilder ( GetDocumentRequest prototype )
public static GetDocumentRequest parseDelimitedFrom ( InputStream input )
public static GetDocumentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static GetDocumentRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static GetDocumentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static GetDocumentRequest parseFrom ( CodedInputStream input )
public static GetDocumentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static GetDocumentRequest parseFrom ( InputStream input )
public static GetDocumentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static GetDocumentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetDocumentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<GetDocumentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
Type Description
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
Type Description
ByteString The bytes for dataset.
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType ()
getDocumentId()
public DocumentId getDocumentId ()
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
DocumentId The documentId.
getDocumentIdOrBuilder()
public DocumentIdOrBuilder getDocumentIdOrBuilder ()
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
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;
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;
getParserForType()
public Parser<GetDocumentRequest> getParserForType ()
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
Type Description
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;
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasDocumentId()
public boolean hasDocumentId ()
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean Whether the documentId field is set.
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
Type Description
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
Type Description
boolean Whether the readMask field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public GetDocumentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetDocumentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public GetDocumentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
