public final class CreateDocumentRequest extends GeneratedMessageV3 implements CreateDocumentRequestOrBuilder
Request message for
DocumentService.CreateDocument
method.
Protobuf type google.cloud.discoveryengine.v1alpha.CreateDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENT_FIELD_NUMBER
public static final int DOCUMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOCUMENT_ID_FIELD_NUMBER
public static final int DOCUMENT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CreateDocumentRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CreateDocumentRequest.Builder newBuilder()
newBuilder(CreateDocumentRequest prototype)
public static CreateDocumentRequest.Builder newBuilder(CreateDocumentRequest prototype)
public static CreateDocumentRequest parseDelimitedFrom(InputStream input)
public static CreateDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CreateDocumentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CreateDocumentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom(CodedInputStream input)
public static CreateDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom(InputStream input)
public static CreateDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CreateDocumentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CreateDocumentRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public CreateDocumentRequest getDefaultInstanceForType()
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.
|
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];
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.
|
getParserForType()
public Parser<CreateDocumentRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CreateDocumentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CreateDocumentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
