Package com.google.cloud.discoveryengine.v1alpha

Interface GetProcessedDocumentRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GetProcessedDocumentRequest, GetProcessedDocumentRequest.Builder
@Generated public interface GetProcessedDocumentRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.Document], regardless of
 whether or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1alpha.Document]
 does not exist, a `NOT_FOUND` error is returned.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getProcessedDocumentTypeValue

      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:
      The enum numeric value on the wire for processedDocumentType.

    • getProcessedDocumentType

      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:
      The processedDocumentType.

    • getProcessedDocumentFormatValue

      int getProcessedDocumentFormatValue()
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Returns:
      The enum numeric value on the wire for processedDocumentFormat.

    • getProcessedDocumentFormat

      GetProcessedDocumentRequest.ProcessedDocumentFormat getProcessedDocumentFormat()
       What format output should be.  If unspecified, defaults to JSON.
      .google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
      Returns:
      The processedDocumentFormat.