0.3.0 (latest) 0.2.0 0.1.0

    public static final class BatchGetDocumentsRequest.Builder extends GeneratedMessage.Builder<BatchGetDocumentsRequest.Builder> implements BatchGetDocumentsRequestOrBuilder

Request message for
DeveloperKnowledge.BatchGetDocuments.

Protobuf type `google.developers.knowledge.v1.BatchGetDocumentsRequest`

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> com.google.protobuf.AbstractMessageLite.Builder \> com.google.protobuf.AbstractMessage.Builder \> com.google.protobuf.GeneratedMessage.Builder \> BatchGetDocumentsRequest.Builder

## Implements

[BatchGetDocumentsRequestOrBuilder](https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequestOrBuilder)

## Inherited Members

com.google.protobuf.AbstractMessage.Builder.findInitializationErrors() com.google.protobuf.AbstractMessage.Builder.getInitializationErrorString() com.google.protobuf.AbstractMessage.Builder.internalMergeFrom(com.google.protobuf.AbstractMessageLite) com.google.protobuf.AbstractMessage.Builder.mergeFrom(byte\[\]) com.google.protobuf.AbstractMessage.Builder.mergeFrom(byte\[\],com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessage.Builder.mergeFrom(byte\[\],int,int) com.google.protobuf.AbstractMessage.Builder.mergeFrom(byte\[\],int,int,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.ByteString) com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.ByteString,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.CodedInputStream) com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.Message) com.google.protobuf.AbstractMessage.Builder.mergeFrom(java.io.InputStream) com.google.protobuf.AbstractMessage.Builder.mergeFrom(java.io.InputStream,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessage.Builder.newUninitializedMessageException(com.google.protobuf.Message) com.google.protobuf.AbstractMessage.Builder.toString() com.google.protobuf.AbstractMessageLite.Builder.\<T\>addAll(java.lang.Iterable\<T\>,java.util.Collection\<? super T\>) com.google.protobuf.AbstractMessageLite.Builder.\<T\>addAll(java.lang.Iterable\<T\>,java.util.List\<? super T\>) com.google.protobuf.AbstractMessageLite.Builder.internalMergeFrom(MessageType) com.google.protobuf.AbstractMessageLite.Builder.mergeDelimitedFrom(java.io.InputStream) com.google.protobuf.AbstractMessageLite.Builder.mergeDelimitedFrom(java.io.InputStream,com.google.protobuf.ExtensionRegistryLite) com.google.protobuf.AbstractMessageLite.Builder.mergeFrom(com.google.protobuf.MessageLite) com.google.protobuf.AbstractMessageLite.Builder.newUninitializedMessageException(com.google.protobuf.MessageLite) com.google.protobuf.GeneratedMessage.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object) com.google.protobuf.GeneratedMessage.Builder.clear() com.google.protobuf.GeneratedMessage.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor) com.google.protobuf.GeneratedMessage.Builder.clone() com.google.protobuf.GeneratedMessage.Builder.getAllFields() com.google.protobuf.GeneratedMessage.Builder.getDescriptorForType() com.google.protobuf.GeneratedMessage.Builder.getField(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.getFieldBuilder(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.getOneofFieldDescriptor(com.google.protobuf.Descriptors.OneofDescriptor) com.google.protobuf.GeneratedMessage.Builder.getParentForChildren() com.google.protobuf.GeneratedMessage.Builder.getRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,int) com.google.protobuf.GeneratedMessage.Builder.getRepeatedFieldBuilder(com.google.protobuf.Descriptors.FieldDescriptor,int) com.google.protobuf.GeneratedMessage.Builder.getRepeatedFieldCount(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder() com.google.protobuf.GeneratedMessage.Builder.getUnknownFields() com.google.protobuf.GeneratedMessage.Builder.hasField(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.hasOneof(com.google.protobuf.Descriptors.OneofDescriptor) com.google.protobuf.GeneratedMessage.Builder.internalGetFieldAccessorTable() com.google.protobuf.GeneratedMessage.Builder.internalGetMapField(int) com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int) com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapField(int) com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int) com.google.protobuf.GeneratedMessage.Builder.isClean() com.google.protobuf.GeneratedMessage.Builder.isInitialized() com.google.protobuf.GeneratedMessage.Builder.markClean() com.google.protobuf.GeneratedMessage.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet) com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString) com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int) com.google.protobuf.GeneratedMessage.Builder.newBuilderForField(com.google.protobuf.Descriptors.FieldDescriptor) com.google.protobuf.GeneratedMessage.Builder.onBuilt() com.google.protobuf.GeneratedMessage.Builder.onChanged() com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int) com.google.protobuf.GeneratedMessage.Builder.setField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object) com.google.protobuf.GeneratedMessage.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,int,java.lang.Object) com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder) com.google.protobuf.GeneratedMessage.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet) com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Static Methods

### getDescriptor()

    public static final Descriptors.Descriptor getDescriptor()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.Descriptors.Descriptor` |   |

## Methods

### addAllNames(Iterable\<String\> values)

    public BatchGetDocumentsRequest.Builder addAllNames(Iterable<String> values)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `values` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` The names to add. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### addNames(String value)

    public BatchGetDocumentsRequest.Builder addNames(String value)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The names to add. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### addNamesBytes(ByteString value)

    public BatchGetDocumentsRequest.Builder addNamesBytes(ByteString value)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `com.google.protobuf.ByteString` The bytes of the names to add. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### build()

    public BatchGetDocumentsRequest build()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest` |   |

### buildPartial()

    public BatchGetDocumentsRequest buildPartial()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest` |   |

### clear()

    public BatchGetDocumentsRequest.Builder clear()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.clear()

### clearNames()

    public BatchGetDocumentsRequest.Builder clearNames()

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### clearView()

    public BatchGetDocumentsRequest.Builder clearView()

Optional. Specifies the
DocumentView of the
document. If unspecified,
DeveloperKnowledge.BatchGetDocuments
defaults to `DOCUMENT_VIEW_CONTENT`.

`
.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### getDefaultInstanceForType()

    public BatchGetDocumentsRequest getDefaultInstanceForType()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest` |   |

### getDescriptorForType()

    public Descriptors.Descriptor getDescriptorForType()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.Descriptors.Descriptor` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.getDescriptorForType()

### getNames(int index)

    public String getNames(int index)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The names at the given index. |

### getNamesBytes(int index)

    public ByteString getNamesBytes(int index)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.ByteString` | The bytes of the names at the given index. |

### getNamesCount()

    public int getNamesCount()

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The count of names. |

### getNamesList()

    public ProtocolStringList getNamesList()

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.ProtocolStringList` | A list containing the names. |

### getView()

    public DocumentView getView()

Optional. Specifies the
DocumentView of the
document. If unspecified,
DeveloperKnowledge.BatchGetDocuments
defaults to `DOCUMENT_VIEW_CONTENT`.

`
.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.DocumentView` | The view. |

### getViewValue()

    public int getViewValue()

Optional. Specifies the
DocumentView of the
document. If unspecified,
DeveloperKnowledge.BatchGetDocuments
defaults to `DOCUMENT_VIEW_CONTENT`.

`
.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for view. |

### internalGetFieldAccessorTable()

    protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.protobuf.GeneratedMessage.FieldAccessorTable` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.internalGetFieldAccessorTable()

### isInitialized()

    public final boolean isInitialized()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

**Overrides** com.google.protobuf.GeneratedMessage.Builder.isInitialized()

### mergeFrom(BatchGetDocumentsRequest other)

    public BatchGetDocumentsRequest.Builder mergeFrom(BatchGetDocumentsRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` |   |

### mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

    public BatchGetDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `input` | `com.google.protobuf.CodedInputStream` |
| `extensionRegistry` | `com.google.protobuf.ExtensionRegistryLite` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` |   |

**Overrides** com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### mergeFrom(Message other)

    public BatchGetDocumentsRequest.Builder mergeFrom(Message other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `com.google.protobuf.Message` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` |   |

**Overrides** com.google.protobuf.AbstractMessage.Builder.mergeFrom(com.google.protobuf.Message)

### setNames(int index, String value)

    public BatchGetDocumentsRequest.Builder setNames(int index, String value)

Required. Specifies the names of the documents to retrieve. A maximum of 20
documents can be retrieved in a batch. The documents are returned in the
same order as the `names` in the request.

Format: `documents/{uri_without_scheme}`
Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`

`
repeated string names = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index to set the value at. |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The names to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### setView(DocumentView value)

    public BatchGetDocumentsRequest.Builder setView(DocumentView value)

Optional. Specifies the
DocumentView of the
document. If unspecified,
DeveloperKnowledge.BatchGetDocuments
defaults to `DOCUMENT_VIEW_CONTENT`.

`
.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.DocumentView` The view to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |

### setViewValue(int value)

    public BatchGetDocumentsRequest.Builder setViewValue(int value)

Optional. Specifies the
DocumentView of the
document. If unspecified,
DeveloperKnowledge.BatchGetDocuments
defaults to `DOCUMENT_VIEW_CONTENT`.

`
.google.developers.knowledge.v1.DocumentView view = 2 [(.google.api.field_behavior) = OPTIONAL];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The enum numeric value on the wire for view to set. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://developers.google.com/java/docs/reference/google-cloud-developer-knowledge/latest/com.google.developers.knowledge.v1.BatchGetDocumentsRequest.Builder` | This builder for chaining. |