Discovery Engine v1 API - Class CreateDocumentRequest (1.5.0)

public sealed class CreateDocumentRequest : IMessage<CreateDocumentRequest>, IEquatable<CreateDocumentRequest>, IDeepCloneable<CreateDocumentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class CreateDocumentRequest.

Request message for [DocumentService.CreateDocument][google.cloud.discoveryengine.v1.DocumentService.CreateDocument] method.

Inheritance

object > CreateDocumentRequest

Implements

IMessage CreateDocumentRequest, IEquatable CreateDocumentRequest, IDeepCloneable CreateDocumentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CreateDocumentRequest()

public CreateDocumentRequest()

CreateDocumentRequest(CreateDocumentRequest)

public CreateDocumentRequest(CreateDocumentRequest other)

Parameter
Name	Description
`other`	`CreateDocumentRequest`

Properties

Document

public Document Document { get; set; }

Required. The [Document][google.cloud.discoveryengine.v1.Document] to create.

Property Value
Type	Description
`Document`

DocumentId

public string DocumentId { get; set; }

Required. The ID to use for the [Document][google.cloud.discoveryengine.v1.Document], which becomes the final component of the [Document.name][google.cloud.discoveryengine.v1.Document.name].

If the caller does not have permission to create the [Document][google.cloud.discoveryengine.v1.Document], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all [Document][google.cloud.discoveryengine.v1.Document]s with the same [parent][google.cloud.discoveryengine.v1.CreateDocumentRequest.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.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Property Value
Type	Description
`string`

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
Type	Description
`BranchName`