Class GetProcessedDocumentRequest (0.38.0)

public final class GetProcessedDocumentRequest extends GeneratedMessageV3 implements GetProcessedDocumentRequestOrBuilder

Request message for DocumentService.GetDocument method.

Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROCESSED_DOCUMENT_FORMAT_FIELD_NUMBER

public static final int PROCESSED_DOCUMENT_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

PROCESSED_DOCUMENT_TYPE_FIELD_NUMBER

public static final int PROCESSED_DOCUMENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GetProcessedDocumentRequest getDefaultInstance()
Returns
Type Description
GetProcessedDocumentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GetProcessedDocumentRequest.Builder newBuilder()
Returns
Type Description
GetProcessedDocumentRequest.Builder

newBuilder(GetProcessedDocumentRequest prototype)

public static GetProcessedDocumentRequest.Builder newBuilder(GetProcessedDocumentRequest prototype)
Parameter
Name Description
prototype GetProcessedDocumentRequest
Returns
Type Description
GetProcessedDocumentRequest.Builder

parseDelimitedFrom(InputStream input)

public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GetProcessedDocumentRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GetProcessedDocumentRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GetProcessedDocumentRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GetProcessedDocumentRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GetProcessedDocumentRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GetProcessedDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GetProcessedDocumentRequest> parser()
Returns
Type Description
Parser<GetProcessedDocumentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GetProcessedDocumentRequest getDefaultInstanceForType()
Returns
Type Description
GetProcessedDocumentRequest

getName()

public 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 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.

getParserForType()

public Parser<GetProcessedDocumentRequest> getParserForType()
Returns
Type Description
Parser<GetProcessedDocumentRequest>
Overrides

getProcessedDocumentFormat()

public 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 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 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GetProcessedDocumentRequest.Builder newBuilderForType()
Returns
Type Description
GetProcessedDocumentRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GetProcessedDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GetProcessedDocumentRequest.Builder toBuilder()
Returns
Type Description
GetProcessedDocumentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException