Interface GetProcessedDocumentRequestOrBuilder (0.43.0)

public interface GetProcessedDocumentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Document does not exist, a NOT_FOUND error is returned.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Document does not exist, a NOT_FOUND error is returned.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getProcessedDocumentFormat()

public abstract GetProcessedDocumentRequest.ProcessedDocumentFormat getProcessedDocumentFormat()

What format output should be. If unspecified, defaults to JSON.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;

Returns
Type Description
GetProcessedDocumentRequest.ProcessedDocumentFormat

The processedDocumentFormat.

getProcessedDocumentFormatValue()

public abstract int getProcessedDocumentFormatValue()

What format output should be. If unspecified, defaults to JSON.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;

Returns
Type Description
int

The enum numeric value on the wire for processedDocumentFormat.

getProcessedDocumentType()

public abstract GetProcessedDocumentRequest.ProcessedDocumentType getProcessedDocumentType()

Required. What type of processing to return.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GetProcessedDocumentRequest.ProcessedDocumentType

The processedDocumentType.

getProcessedDocumentTypeValue()

public abstract int getProcessedDocumentTypeValue()

Required. What type of processing to return.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for processedDocumentType.