Class GetDocumentRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
com.google.cloud.documentai.v1beta3.GetDocumentRequest.Builder
- All Implemented Interfaces:
GetDocumentRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- GetDocumentRequest
public static final class GetDocumentRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
implements GetDocumentRequestOrBuilder
Protobuf type
google.cloud.documentai.v1beta3.GetDocumentRequest-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()Required.Required.List of pages for which the fields specified in the `read_mask` must be served.If set, only fields listed here will be returned.Required.com.google.protobuf.ByteStringRequired.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorRequired.Required.Required.List of pages for which the fields specified in the `read_mask` must be served.List of pages for which the fields specified in the `read_mask` must be served.List of pages for which the fields specified in the `read_mask` must be served.com.google.protobuf.FieldMaskIf set, only fields listed here will be returned.com.google.protobuf.FieldMask.BuilderIf set, only fields listed here will be returned.com.google.protobuf.FieldMaskOrBuilderIf set, only fields listed here will be returned.booleanRequired.booleanList of pages for which the fields specified in the `read_mask` must be served.booleanIf set, only fields listed here will be returned.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeDocumentId(DocumentId value) Required.mergeFrom(GetDocumentRequest other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergePageRange(DocumentPageRange value) List of pages for which the fields specified in the `read_mask` must be served.mergeReadMask(com.google.protobuf.FieldMask value) If set, only fields listed here will be returned.setDataset(String value) Required.setDatasetBytes(com.google.protobuf.ByteString value) Required.setDocumentId(DocumentId value) Required.setDocumentId(DocumentId.Builder builderForValue) Required.setPageRange(DocumentPageRange value) List of pages for which the fields specified in the `read_mask` must be served.setPageRange(DocumentPageRange.Builder builderForValue) List of pages for which the fields specified in the `read_mask` must be served.setReadMask(com.google.protobuf.FieldMask value) If set, only fields listed here will be returned.setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) If set, only fields listed here will be returned.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
-
mergeFrom
public GetDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>- Throws:
IOException
-
getDataset
Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/datasetstring dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getDatasetin interfaceGetDocumentRequestOrBuilder- 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}/datasetstring dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getDatasetBytesin interfaceGetDocumentRequestOrBuilder- Returns:
- The bytes for dataset.
-
setDataset
Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/datasetstring dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The dataset to set.- Returns:
- This builder for chaining.
-
clearDataset
Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/datasetstring dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setDatasetBytes
Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/datasetstring dataset = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for dataset to set.- Returns:
- This builder for chaining.
-
hasDocumentId
public boolean hasDocumentId()Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasDocumentIdin interfaceGetDocumentRequestOrBuilder- Returns:
- Whether the documentId field is set.
-
getDocumentId
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDocumentIdin interfaceGetDocumentRequestOrBuilder- Returns:
- The documentId.
-
setDocumentId
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED]; -
setDocumentId
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED]; -
mergeDocumentId
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED]; -
clearDocumentId
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED]; -
getDocumentIdBuilder
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED]; -
getDocumentIdOrBuilder
Required. Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDocumentIdOrBuilderin interfaceGetDocumentRequestOrBuilder
-
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:
hasReadMaskin interfaceGetDocumentRequestOrBuilder- 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:
getReadMaskin interfaceGetDocumentRequestOrBuilder- Returns:
- The readMask.
-
setReadMask
If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
.google.protobuf.FieldMask read_mask = 3; -
setReadMask
public GetDocumentRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue) If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
.google.protobuf.FieldMask read_mask = 3; -
mergeReadMask
If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
.google.protobuf.FieldMask read_mask = 3; -
clearReadMask
If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
.google.protobuf.FieldMask read_mask = 3; -
getReadMaskBuilder
public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
.google.protobuf.FieldMask read_mask = 3; -
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:
getReadMaskOrBuilderin interfaceGetDocumentRequestOrBuilder
-
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:
hasPageRangein interfaceGetDocumentRequestOrBuilder- Returns:
- Whether the pageRange field is set.
-
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:
getPageRangein interfaceGetDocumentRequestOrBuilder- Returns:
- The pageRange.
-
setPageRange
List of pages for which the fields specified in the `read_mask` must be served.
.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4; -
setPageRange
List of pages for which the fields specified in the `read_mask` must be served.
.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4; -
mergePageRange
List of pages for which the fields specified in the `read_mask` must be served.
.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4; -
clearPageRange
List of pages for which the fields specified in the `read_mask` must be served.
.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4; -
getPageRangeBuilder
List of pages for which the fields specified in the `read_mask` must be served.
.google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4; -
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:
getPageRangeOrBuilderin interfaceGetDocumentRequestOrBuilder
-