com.google.cloud.discoveryengine.v1alpha

Class GetProcessedDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

All Implemented Interfaces:

GetProcessedDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GetProcessedDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GetProcessedDocumentRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetProcessedDocumentRequest.Builder Request message for [DocumentService.GetDocument][google.cloud.discoveryengine.v1alpha.DocumentService.GetDocument] method.
static class	GetProcessedDocumentRequest.ProcessedDocumentFormat The format of the returned processed document.
static class	GetProcessedDocumentRequest.ProcessedDocumentType The type of processing to return in the response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAME_FIELD_NUMBER
static int	PROCESSED_DOCUMENT_FORMAT_FIELD_NUMBER
static int	PROCESSED_DOCUMENT_TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static GetProcessedDocumentRequest	getDefaultInstance()
GetProcessedDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<GetProcessedDocumentRequest>	getParserForType()
GetProcessedDocumentRequest.ProcessedDocumentFormat	getProcessedDocumentFormat() What format output should be.
int	getProcessedDocumentFormatValue() What format output should be.
GetProcessedDocumentRequest.ProcessedDocumentType	getProcessedDocumentType() Required.
int	getProcessedDocumentTypeValue() Required.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GetProcessedDocumentRequest.Builder	newBuilder()
static GetProcessedDocumentRequest.Builder	newBuilder(GetProcessedDocumentRequest prototype)
GetProcessedDocumentRequest.Builder	newBuilderForType()
protected GetProcessedDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GetProcessedDocumentRequest	parseDelimitedFrom(InputStream input)
static GetProcessedDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetProcessedDocumentRequest	parseFrom(byte[] data)
static GetProcessedDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetProcessedDocumentRequest	parseFrom(ByteBuffer data)
static GetProcessedDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetProcessedDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static GetProcessedDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetProcessedDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GetProcessedDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GetProcessedDocumentRequest	parseFrom(InputStream input)
static GetProcessedDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GetProcessedDocumentRequest>	parser()
GetProcessedDocumentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

PROCESSED_DOCUMENT_TYPE_FIELD_NUMBER

public static final int PROCESSED_DOCUMENT_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PROCESSED_DOCUMENT_FORMAT_FIELD_NUMBER

public static final int PROCESSED_DOCUMENT_FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public 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) = { ... }

Specified by:

getName in interface GetProcessedDocumentRequestOrBuilder

Returns:

The name.

getNameBytes

public 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) = { ... }

Specified by:

getNameBytes in interface GetProcessedDocumentRequestOrBuilder

Returns:

The bytes for name.

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];

Specified by:

getProcessedDocumentTypeValue in interface GetProcessedDocumentRequestOrBuilder

Returns:

The enum numeric value on the wire for processedDocumentType.

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];

Specified by:

getProcessedDocumentType in interface GetProcessedDocumentRequestOrBuilder

Returns:

The processedDocumentType.

getProcessedDocumentFormatValue

public int getProcessedDocumentFormatValue()

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

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

Specified by:

getProcessedDocumentFormatValue in interface GetProcessedDocumentRequestOrBuilder

Returns:

The enum numeric value on the wire for processedDocumentFormat.

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;

Specified by:

getProcessedDocumentFormat in interface GetProcessedDocumentRequestOrBuilder

Returns:

The processedDocumentFormat.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GetProcessedDocumentRequest parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GetProcessedDocumentRequest parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static GetProcessedDocumentRequest parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static GetProcessedDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static GetProcessedDocumentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public GetProcessedDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GetProcessedDocumentRequest.Builder newBuilder()

newBuilder

public static GetProcessedDocumentRequest.Builder newBuilder(GetProcessedDocumentRequest prototype)

toBuilder

public GetProcessedDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GetProcessedDocumentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GetProcessedDocumentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<GetProcessedDocumentRequest> parser()

getParserForType

public com.google.protobuf.Parser<GetProcessedDocumentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GetProcessedDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder