GetProcessedDocumentRequest.Builder (proto-google-cloud-discoveryengine-v1alpha 0.45.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
    - - com.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.Builder

All Implemented Interfaces:

GetProcessedDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GetProcessedDocumentRequest
```
public static final class GetProcessedDocumentRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
implements GetProcessedDocumentRequestOrBuilder
```
```
 Request message for
 [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetProcessedDocumentRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GetProcessedDocumentRequest`	`build()`
`GetProcessedDocumentRequest`	`buildPartial()`
`GetProcessedDocumentRequest.Builder`	`clear()`
`GetProcessedDocumentRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`GetProcessedDocumentRequest.Builder`	`clearName()` Required.
`GetProcessedDocumentRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`GetProcessedDocumentRequest.Builder`	`clearProcessedDocumentFormat()` What format output should be.
`GetProcessedDocumentRequest.Builder`	`clearProcessedDocumentType()` Required.
`GetProcessedDocumentRequest.Builder`	`clone()`
`GetProcessedDocumentRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`GetProcessedDocumentRequest.ProcessedDocumentFormat`	`getProcessedDocumentFormat()` What format output should be.
`int`	`getProcessedDocumentFormatValue()` What format output should be.
`GetProcessedDocumentRequest.ProcessedDocumentType`	`getProcessedDocumentType()` Required.
`int`	`getProcessedDocumentTypeValue()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`GetProcessedDocumentRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GetProcessedDocumentRequest.Builder`	`mergeFrom(GetProcessedDocumentRequest other)`
`GetProcessedDocumentRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GetProcessedDocumentRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GetProcessedDocumentRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`GetProcessedDocumentRequest.Builder`	`setName(String value)` Required.
`GetProcessedDocumentRequest.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Required.
`GetProcessedDocumentRequest.Builder`	`setProcessedDocumentFormat(GetProcessedDocumentRequest.ProcessedDocumentFormat value)` What format output should be.
`GetProcessedDocumentRequest.Builder`	`setProcessedDocumentFormatValue(int value)` What format output should be.
`GetProcessedDocumentRequest.Builder`	`setProcessedDocumentType(GetProcessedDocumentRequest.ProcessedDocumentType value)` Required.
`GetProcessedDocumentRequest.Builder`	`setProcessedDocumentTypeValue(int value)` Required.
`GetProcessedDocumentRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`GetProcessedDocumentRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<GetProcessedDocumentRequest.Builder>
  - clear
```
public GetProcessedDocumentRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - getDefaultInstanceForType
```
public GetProcessedDocumentRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public GetProcessedDocumentRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public GetProcessedDocumentRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public GetProcessedDocumentRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - setField
```
public GetProcessedDocumentRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - clearField
```
public GetProcessedDocumentRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - clearOneof
```
public GetProcessedDocumentRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - setRepeatedField
```
public GetProcessedDocumentRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            int index,
                                                            Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - addRepeatedField
```
public GetProcessedDocumentRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                            Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - mergeFrom
```
public GetProcessedDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetProcessedDocumentRequest.Builder>
  - mergeFrom
```
public GetProcessedDocumentRequest.Builder mergeFrom(GetProcessedDocumentRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - mergeFrom
```
public GetProcessedDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetProcessedDocumentRequest.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getName in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
    Specified by:
    
    getNameBytes in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public GetProcessedDocumentRequest.Builder setName(String value)
```
```
 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public GetProcessedDocumentRequest.Builder clearName()
```
```
 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
    Returns:
    
    This builder for chaining.
  - setNameBytes
```
public GetProcessedDocumentRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.Document], such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.

 If the caller does not have permission to access the
 [Document][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
 
```
    string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - getProcessedDocumentTypeValue
```
public int getProcessedDocumentTypeValue()
```
```
 Required. What type of processing to return.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getProcessedDocumentTypeValue in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for processedDocumentType.
  - setProcessedDocumentTypeValue
```
public GetProcessedDocumentRequest.Builder setProcessedDocumentTypeValue(int value)
```
```
 Required. What type of processing to return.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The enum numeric value on the wire for processedDocumentType to set.
    
    Returns:
    
    This builder for chaining.
  - getProcessedDocumentType
```
public GetProcessedDocumentRequest.ProcessedDocumentType getProcessedDocumentType()
```
```
 Required. What type of processing to return.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getProcessedDocumentType in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The processedDocumentType.
  - setProcessedDocumentType
```
public GetProcessedDocumentRequest.Builder setProcessedDocumentType(GetProcessedDocumentRequest.ProcessedDocumentType value)
```
```
 Required. What type of processing to return.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The processedDocumentType to set.
    
    Returns:
    
    This builder for chaining.
  - clearProcessedDocumentType
```
public GetProcessedDocumentRequest.Builder clearProcessedDocumentType()
```
```
 Required. What type of processing to return.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - getProcessedDocumentFormatValue
```
public int getProcessedDocumentFormatValue()
```
```
 What format output should be.  If unspecified, defaults to JSON.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
    Specified by:
    
    getProcessedDocumentFormatValue in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for processedDocumentFormat.
  - setProcessedDocumentFormatValue
```
public GetProcessedDocumentRequest.Builder setProcessedDocumentFormatValue(int value)
```
```
 What format output should be.  If unspecified, defaults to JSON.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
    Parameters:
    
    value - The enum numeric value on the wire for processedDocumentFormat to set.
    
    Returns:
    
    This builder for chaining.
  - getProcessedDocumentFormat
```
public GetProcessedDocumentRequest.ProcessedDocumentFormat getProcessedDocumentFormat()
```
```
 What format output should be.  If unspecified, defaults to JSON.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
    Specified by:
    
    getProcessedDocumentFormat in interface GetProcessedDocumentRequestOrBuilder
    
    Returns:
    
    The processedDocumentFormat.
  - setProcessedDocumentFormat
```
public GetProcessedDocumentRequest.Builder setProcessedDocumentFormat(GetProcessedDocumentRequest.ProcessedDocumentFormat value)
```
```
 What format output should be.  If unspecified, defaults to JSON.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
    Parameters:
    
    value - The processedDocumentFormat to set.
    
    Returns:
    
    This builder for chaining.
  - clearProcessedDocumentFormat
```
public GetProcessedDocumentRequest.Builder clearProcessedDocumentFormat()
```
```
 What format output should be.  If unspecified, defaults to JSON.
 
```
    .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final GetProcessedDocumentRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>
  - mergeUnknownFields
```
public final GetProcessedDocumentRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder>

Class GetProcessedDocumentRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

getProcessedDocumentTypeValue

setProcessedDocumentTypeValue

getProcessedDocumentType

setProcessedDocumentType

clearProcessedDocumentType

getProcessedDocumentFormatValue

setProcessedDocumentFormatValue

getProcessedDocumentFormat

setProcessedDocumentFormat

clearProcessedDocumentFormat

setUnknownFields

mergeUnknownFields