- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class CreateDocumentRequest.Builder extends GeneratedMessageV3.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilderRequest message for DocumentService.CreateDocument method.
Protobuf type google.cloud.discoveryengine.v1alpha.CreateDocumentRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateDocumentRequest.BuilderImplements
CreateDocumentRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
build()
public CreateDocumentRequest build()| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest |
|
buildPartial()
public CreateDocumentRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest |
|
clear()
public CreateDocumentRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
clearDocument()
public CreateDocumentRequest.Builder clearDocument()Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
clearDocumentId()
public CreateDocumentRequest.Builder clearDocumentId()Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all
Documents with the same
parent.
Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034
standard with a length limit of 63 characters. Otherwise, an
INVALID_ARGUMENT error is returned.
string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
clearParent()
public CreateDocumentRequest.Builder clearParent() Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
clone()
public CreateDocumentRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
getDefaultInstanceForType()
public CreateDocumentRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDocument()
public Document getDocument()Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Document |
The document. |
getDocumentBuilder()
public Document.Builder getDocumentBuilder()Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Document.Builder |
|
getDocumentId()
public String getDocumentId()Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all
Documents with the same
parent.
Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034
standard with a length limit of 63 characters. Otherwise, an
INVALID_ARGUMENT error is returned.
string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The documentId. |
getDocumentIdBytes()
public ByteString getDocumentIdBytes()Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all
Documents with the same
parent.
Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034
standard with a length limit of 63 characters. Otherwise, an
INVALID_ARGUMENT error is returned.
string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for documentId. |
getDocumentOrBuilder()
public DocumentOrBuilder getDocumentOrBuilder()Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DocumentOrBuilder |
|
getParent()
public String getParent() Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
hasDocument()
public boolean hasDocument()Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the document field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDocument(Document value)
public CreateDocumentRequest.Builder mergeDocument(Document value)Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Document |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
mergeFrom(CreateDocumentRequest other)
public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CreateDocumentRequest |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CreateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CreateDocumentRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
setDocument(Document value)
public CreateDocumentRequest.Builder setDocument(Document value)Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Document |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
setDocument(Document.Builder builderForValue)
public CreateDocumentRequest.Builder setDocument(Document.Builder builderForValue)Required. The Document to create.
.google.cloud.discoveryengine.v1alpha.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Document.Builder |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
setDocumentId(String value)
public CreateDocumentRequest.Builder setDocumentId(String value)Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all
Documents with the same
parent.
Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034
standard with a length limit of 63 characters. Otherwise, an
INVALID_ARGUMENT error is returned.
string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe documentId to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
setDocumentIdBytes(ByteString value)
public CreateDocumentRequest.Builder setDocumentIdBytes(ByteString value)Required. The ID to use for the Document, which becomes the final component of the Document.name.
If the caller does not have permission to create the
Document, regardless of
whether or not it exists, a PERMISSION_DENIED error is returned.
This field must be unique among all
Documents with the same
parent.
Otherwise, an ALREADY_EXISTS error is returned.
This field must conform to RFC-1034
standard with a length limit of 63 characters. Otherwise, an
INVALID_ARGUMENT error is returned.
string document_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for documentId to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
setParent(String value)
public CreateDocumentRequest.Builder setParent(String value) Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public CreateDocumentRequest.Builder setParentBytes(ByteString value) Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CreateDocumentRequest.Builder |
|