public static final class CreateDocumentRequest.Builder extends GeneratedMessageV3.Builder<CreateDocumentRequest.Builder> implements CreateDocumentRequestOrBuilder
Request message for
DocumentService.CreateDocument
method.
Protobuf type google.cloud.discoveryengine.v1beta.CreateDocumentRequest
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 CreateDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CreateDocumentRequest build()
buildPartial()
public CreateDocumentRequest buildPartial()
clear()
public CreateDocumentRequest.Builder clear()
Overrides
clearDocument()
public CreateDocumentRequest.Builder clearDocument()
Required. The Document to
create.
.google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
clearDocumentId()
public CreateDocumentRequest.Builder clearDocumentId()
Required. The ID to use for the
Document, which will become
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];
clearField(Descriptors.FieldDescriptor field)
public CreateDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
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) = { ... }
clone()
public CreateDocumentRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public CreateDocumentRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getDocument()
public Document getDocument()
Required. The Document to
create.
.google.cloud.discoveryengine.v1beta.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.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
getDocumentId()
public String getDocumentId()
Required. The ID to use for the
Document, which will become
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 will become
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.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
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.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the document field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeDocument(Document value)
public CreateDocumentRequest.Builder mergeDocument(Document value)
Required. The Document to
create.
.google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
mergeFrom(CreateDocumentRequest other)
public CreateDocumentRequest.Builder mergeFrom(CreateDocumentRequest other)
public CreateDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CreateDocumentRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setDocument(Document value)
public CreateDocumentRequest.Builder setDocument(Document value)
Required. The Document to
create.
.google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
setDocument(Document.Builder builderForValue)
public CreateDocumentRequest.Builder setDocument(Document.Builder builderForValue)
Required. The Document to
create.
.google.cloud.discoveryengine.v1beta.Document document = 2 [(.google.api.field_behavior) = REQUIRED];
setDocumentId(String value)
public CreateDocumentRequest.Builder setDocumentId(String value)
Required. The ID to use for the
Document, which will become
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 | String
The documentId to set.
|
setDocumentIdBytes(ByteString value)
public CreateDocumentRequest.Builder setDocumentIdBytes(ByteString value)
Required. The ID to use for the
Document, which will become
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 | ByteString
The bytes for documentId to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public CreateDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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 | String
The parent to set.
|
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 | ByteString
The bytes for parent to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CreateDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
