com.google.cloud.documentai.v1beta3

Class GetDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.GetDocumentRequest

All Implemented Interfaces:

GetDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GetDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GetDocumentRequestOrBuilder

Protobuf type google.cloud.documentai.v1beta3.GetDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetDocumentRequest.Builder Protobuf type google.cloud.documentai.v1beta3.GetDocumentRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATASET_FIELD_NUMBER
static int	DOCUMENT_ID_FIELD_NUMBER
static int	PAGE_RANGE_FIELD_NUMBER
static int	READ_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDataset() Required.
com.google.protobuf.ByteString	getDatasetBytes() Required.
static GetDocumentRequest	getDefaultInstance()
GetDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentId	getDocumentId() Required.
DocumentIdOrBuilder	getDocumentIdOrBuilder() Required.
DocumentPageRange	getPageRange() List of pages for which the fields specified in the `read_mask` must be served.
DocumentPageRangeOrBuilder	getPageRangeOrBuilder() List of pages for which the fields specified in the `read_mask` must be served.
com.google.protobuf.Parser<GetDocumentRequest>	getParserForType()
com.google.protobuf.FieldMask	getReadMask() If set, only fields listed here will be returned.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() If set, only fields listed here will be returned.
int	getSerializedSize()
boolean	hasDocumentId() Required.
int	hashCode()
boolean	hasPageRange() List of pages for which the fields specified in the `read_mask` must be served.
boolean	hasReadMask() If set, only fields listed here will be returned.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GetDocumentRequest.Builder	newBuilder()
static GetDocumentRequest.Builder	newBuilder(GetDocumentRequest prototype)
GetDocumentRequest.Builder	newBuilderForType()
protected GetDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GetDocumentRequest	parseDelimitedFrom(InputStream input)
static GetDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(byte[] data)
static GetDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(ByteBuffer data)
static GetDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static GetDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GetDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetDocumentRequest	parseFrom(InputStream input)
static GetDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GetDocumentRequest>	parser()
GetDocumentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER

See Also:

Constant Field Values

READ_MASK_FIELD_NUMBER

public static final int READ_MASK_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_RANGE_FIELD_NUMBER

public static final int PAGE_RANGE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getDataset in interface GetDocumentRequestOrBuilder

Returns:

The dataset.

getDatasetBytes

public com.google.protobuf.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) = { ... }

Specified by:

getDatasetBytes in interface GetDocumentRequestOrBuilder

Returns:

The bytes for dataset.

hasDocumentId

public boolean hasDocumentId()

 Required. Document identifier.
 

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

Specified by:

hasDocumentId in interface GetDocumentRequestOrBuilder

Returns:

Whether the documentId field is set.

getDocumentId

public DocumentId getDocumentId()

 Required. Document identifier.
 

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

Specified by:

getDocumentId in interface GetDocumentRequestOrBuilder

Returns:

The documentId.

getDocumentIdOrBuilder

public DocumentIdOrBuilder getDocumentIdOrBuilder()

 Required. Document identifier.
 

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

Specified by:

getDocumentIdOrBuilder in interface GetDocumentRequestOrBuilder

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;

Specified by:

hasReadMask in interface GetDocumentRequestOrBuilder

Returns:

Whether the readMask field is set.

getReadMask

public com.google.protobuf.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;

Specified by:

getReadMask in interface GetDocumentRequestOrBuilder

Returns:

The readMask.

getReadMaskOrBuilder

public com.google.protobuf.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;

Specified by:

getReadMaskOrBuilder in interface GetDocumentRequestOrBuilder

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;

Specified by:

hasPageRange in interface GetDocumentRequestOrBuilder

Returns:

Whether the pageRange field is set.

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;

Specified by:

getPageRange in interface GetDocumentRequestOrBuilder

Returns:

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;

Specified by:

getPageRangeOrBuilder in interface GetDocumentRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GetDocumentRequest parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetDocumentRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetDocumentRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetDocumentRequest parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static GetDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public GetDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GetDocumentRequest.Builder newBuilder()

newBuilder

public static GetDocumentRequest.Builder newBuilder(GetDocumentRequest prototype)

toBuilder

public GetDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GetDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GetDocumentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<GetDocumentRequest> parser()

getParserForType

public com.google.protobuf.Parser<GetDocumentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GetDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder