- 2.82.0 (latest)
- 2.80.0
- 2.79.0
- 2.78.0
- 2.77.0
- 2.76.0
- 2.74.0
- 2.72.0
- 2.71.0
- 2.68.0
- 2.67.0
- 2.66.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public static final class GetDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilderProtobuf type google.cloud.documentai.v1beta3.GetDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GetDocumentRequest.BuilderImplements
GetDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
build()
public GetDocumentRequest build()| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest | |
buildPartial()
public GetDocumentRequest buildPartial()| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest | |
clear()
public GetDocumentRequest.Builder clear()| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
clearDataset()
public GetDocumentRequest.Builder clearDataset()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 | 
| GetDocumentRequest.Builder | This builder for chaining. | 
clearDocumentId()
public GetDocumentRequest.Builder clearDocumentId()Required. Document identifier.
 
 .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public GetDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public GetDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
| oneof | OneofDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
clearPageRange()
public GetDocumentRequest.Builder clearPageRange() 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 | 
| GetDocumentRequest.Builder | |
clearReadMask()
public GetDocumentRequest.Builder clearReadMask()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 | 
| GetDocumentRequest.Builder | |
clone()
public GetDocumentRequest.Builder clone()| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
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. | 
getDocumentIdBuilder()
public DocumentId.Builder getDocumentIdBuilder()Required. Document identifier.
 
 .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Returns | |
|---|---|
| Type | Description | 
| DocumentId.Builder | |
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. | 
getPageRangeBuilder()
public DocumentPageRange.Builder getPageRangeBuilder() 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.Builder | |
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 | |
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. | 
getReadMaskBuilder()
public 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;
| Returns | |
|---|---|
| Type | Description | 
| Builder | |
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 | |
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. | 
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
| FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
| boolean | |
mergeDocumentId(DocumentId value)
public GetDocumentRequest.Builder mergeDocumentId(DocumentId value)Required. Document identifier.
 
 .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | DocumentId | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
mergeFrom(GetDocumentRequest other)
public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)| Parameter | |
|---|---|
| Name | Description | 
| other | GetDocumentRequest | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GetDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
| input | CodedInputStream | 
| extensionRegistry | ExtensionRegistryLite | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description | 
| IOException | |
mergeFrom(Message other)
public GetDocumentRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
| other | Message | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
mergePageRange(DocumentPageRange value)
public GetDocumentRequest.Builder mergePageRange(DocumentPageRange value) List of pages for which the fields specified in the read_mask must
 be served.
 .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
| Parameter | |
|---|---|
| Name | Description | 
| value | DocumentPageRange | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
mergeReadMask(FieldMask value)
public GetDocumentRequest.Builder mergeReadMask(FieldMask value)If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
 .google.protobuf.FieldMask read_mask = 3;
| Parameter | |
|---|---|
| Name | Description | 
| value | FieldMask | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setDataset(String value)
public GetDocumentRequest.Builder setDataset(String value)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) = { ... }
 
| Parameter | |
|---|---|
| Name | Description | 
| value | StringThe dataset to set. | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | This builder for chaining. | 
setDatasetBytes(ByteString value)
public GetDocumentRequest.Builder setDatasetBytes(ByteString value)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) = { ... }
 
| Parameter | |
|---|---|
| Name | Description | 
| value | ByteStringThe bytes for dataset to set. | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | This builder for chaining. | 
setDocumentId(DocumentId value)
public GetDocumentRequest.Builder setDocumentId(DocumentId value)Required. Document identifier.
 
 .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | DocumentId | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setDocumentId(DocumentId.Builder builderForValue)
public GetDocumentRequest.Builder setDocumentId(DocumentId.Builder builderForValue)Required. Document identifier.
 
 .google.cloud.documentai.v1beta3.DocumentId document_id = 2 [(.google.api.field_behavior) = REQUIRED];
 
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | DocumentId.Builder | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setPageRange(DocumentPageRange value)
public GetDocumentRequest.Builder setPageRange(DocumentPageRange value) List of pages for which the fields specified in the read_mask must
 be served.
 .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
| Parameter | |
|---|---|
| Name | Description | 
| value | DocumentPageRange | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setPageRange(DocumentPageRange.Builder builderForValue)
public GetDocumentRequest.Builder setPageRange(DocumentPageRange.Builder builderForValue) List of pages for which the fields specified in the read_mask must
 be served.
 .google.cloud.documentai.v1beta3.DocumentPageRange page_range = 4;
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | DocumentPageRange.Builder | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setReadMask(FieldMask value)
public GetDocumentRequest.Builder setReadMask(FieldMask value)If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.
 .google.protobuf.FieldMask read_mask = 3;
| Parameter | |
|---|---|
| Name | Description | 
| value | FieldMask | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setReadMask(FieldMask.Builder builderForValue)
public GetDocumentRequest.Builder setReadMask(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;
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | Builder | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| index | int | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| GetDocumentRequest.Builder | |