public static final class GetDocumentRequest.Builder extends GeneratedMessage.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilderRequest message for DocumentService.GetDocument method.
Protobuf type google.cloud.discoveryengine.v1alpha.GetDocumentRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GetDocumentRequest.BuilderImplements
GetDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
clearName()
public GetDocumentRequest.Builder clearName() Required. Full resource name of
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, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public String getName() Required. Full resource name of
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, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Required. Full resource name of
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, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
setName(String value)
public GetDocumentRequest.Builder setName(String value) Required. Full resource name of
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, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public GetDocumentRequest.Builder setNameBytes(ByteString value) Required. Full resource name of
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, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
If the requested Document
does not exist, a NOT_FOUND error is returned.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GetDocumentRequest.Builder |
This builder for chaining. |