Class CreateDocumentRequest.Builder (0.40.0)

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

Static 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
Overrides

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
Overrides

clearDocument()

public CreateDocumentRequest.Builder clearDocument()

Required. The Document to create.

.google.cloud.discoveryengine.v1beta.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 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
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
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateDocumentRequest.Builder
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) = { ... }

Returns
Type Description
CreateDocumentRequest.Builder

This builder for chaining.

clone()

public CreateDocumentRequest.Builder clone()
Returns
Type Description
CreateDocumentRequest.Builder
Overrides

getDefaultInstanceForType()

public CreateDocumentRequest getDefaultInstanceForType()
Returns
Type Description
CreateDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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];

Returns
Type Description
Document.Builder

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];

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.v1beta.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
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
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];

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateDocumentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateDocumentRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateDocumentRequest.Builder
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];

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.v1beta.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 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.

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 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.

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
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.

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 ByteString

The 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
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateDocumentRequest.Builder
Overrides