Class GetDocumentRequest (2.46.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
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()
Returns
Type Description
GetDocumentRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GetDocumentRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
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()
Returns
Type Description
GetDocumentRequest

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];

Returns
Type Description
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
Type Description
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
Type Description
DocumentPageRangeOrBuilder

getParserForType()

public Parser<GetDocumentRequest> getParserForType()
Returns
Type Description
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
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;

Returns
Type Description
FieldMaskOrBuilder

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.

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
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()

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 GetDocumentRequest.Builder newBuilderForType()
Returns
Type Description
GetDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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