Struct google_api_proto::google::cloud::discoveryengine::v1alpha::GetProcessedDocumentRequest

pub struct GetProcessedDocumentRequest {
    pub name: String,
    pub processed_document_type: i32,
    pub processed_document_format: i32,
}

Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.

Fields

name: String

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.

processed_document_type: i32

Required. What type of processing to return.

processed_document_format: i32

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

Implementations

impl GetProcessedDocumentRequest

pub fn processed_document_type(&self) -> ProcessedDocumentType

Returns the enum value of processed_document_type, or the default if the field is set to an invalid enum value.

pub fn set_processed_document_type(&mut self, value: ProcessedDocumentType)

Sets processed_document_type to the provided enum value.

pub fn processed_document_format(&self) -> ProcessedDocumentFormat

Returns the enum value of processed_document_format, or the default if the field is set to an invalid enum value.

pub fn set_processed_document_format(&mut self, value: ProcessedDocumentFormat)

Sets processed_document_format to the provided enum value.

Trait Implementations

impl Clone for GetProcessedDocumentRequest

fn clone(&self) -> GetProcessedDocumentRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetProcessedDocumentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetProcessedDocumentRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetProcessedDocumentRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GetProcessedDocumentRequest

fn eq(&self, other: &GetProcessedDocumentRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetProcessedDocumentRequest