public static final class GetDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetDocumentRequest.Builder> implements GetDocumentRequestOrBuilder
Request message for
DocumentService.GetDocument
method.
Protobuf type google.cloud.discoveryengine.v1.GetDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public GetDocumentRequest build()
buildPartial()
public GetDocumentRequest buildPartial()
clear()
public GetDocumentRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public GetDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public GetDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public GetDocumentRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public GetDocumentRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(GetDocumentRequest other)
public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)
public GetDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public GetDocumentRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public GetDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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 | String
The name to set.
|
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 | ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GetDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final GetDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
