public final class GetProcessedDocumentRequest extends GeneratedMessageV3 implements GetProcessedDocumentRequestOrBuilder
Request message for
DocumentService.GetDocument
method.
Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GetProcessedDocumentRequest.Builder newBuilder()
newBuilder(GetProcessedDocumentRequest prototype)
public static GetProcessedDocumentRequest.Builder newBuilder(GetProcessedDocumentRequest prototype)
public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input)
public static GetProcessedDocumentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GetProcessedDocumentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GetProcessedDocumentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GetProcessedDocumentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetProcessedDocumentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GetProcessedDocumentRequest parseFrom(CodedInputStream input)
public static GetProcessedDocumentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GetProcessedDocumentRequest parseFrom(InputStream input)
public static GetProcessedDocumentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GetProcessedDocumentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GetProcessedDocumentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GetProcessedDocumentRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public GetProcessedDocumentRequest getDefaultInstanceForType()
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()
Overrides
public GetProcessedDocumentRequest.ProcessedDocumentFormat getProcessedDocumentFormat()
What format output should be. If unspecified, defaults to JSON.
.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentFormat processed_document_format = 3;
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];
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GetProcessedDocumentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GetProcessedDocumentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GetProcessedDocumentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
