Class GetProcessedDocumentRequest.Builder (0.42.0)

public static final class GetProcessedDocumentRequest.Builder extends GeneratedMessageV3.Builder<GetProcessedDocumentRequest.Builder> implements GetProcessedDocumentRequestOrBuilder

Request message for DocumentService.GetDocument method.

Protobuf type google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GetProcessedDocumentRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

build()

public GetProcessedDocumentRequest build()
Returns
Type Description
GetProcessedDocumentRequest

buildPartial()

public GetProcessedDocumentRequest buildPartial()
Returns
Type Description
GetProcessedDocumentRequest

clear()

public GetProcessedDocumentRequest.Builder clear()
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GetProcessedDocumentRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

clearName()

public GetProcessedDocumentRequest.Builder clearName()

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
GetProcessedDocumentRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GetProcessedDocumentRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

clearProcessedDocumentFormat()

public GetProcessedDocumentRequest.Builder clearProcessedDocumentFormat()

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

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

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

clearProcessedDocumentType()

public GetProcessedDocumentRequest.Builder clearProcessedDocumentType()

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

This builder for chaining.

clone()

public GetProcessedDocumentRequest.Builder clone()
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

getDefaultInstanceForType()

public GetProcessedDocumentRequest getDefaultInstanceForType()
Returns
Type Description
GetProcessedDocumentRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GetProcessedDocumentRequest other)

public GetProcessedDocumentRequest.Builder mergeFrom(GetProcessedDocumentRequest other)
Parameter
Name Description
other GetProcessedDocumentRequest
Returns
Type Description
GetProcessedDocumentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GetProcessedDocumentRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GetProcessedDocumentRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GetProcessedDocumentRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GetProcessedDocumentRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

setName(String value)

public GetProcessedDocumentRequest.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public GetProcessedDocumentRequest.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setProcessedDocumentFormat(GetProcessedDocumentRequest.ProcessedDocumentFormat value)

public GetProcessedDocumentRequest.Builder setProcessedDocumentFormat(GetProcessedDocumentRequest.ProcessedDocumentFormat value)

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

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

Parameter
Name Description
value GetProcessedDocumentRequest.ProcessedDocumentFormat

The processedDocumentFormat to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setProcessedDocumentFormatValue(int value)

public GetProcessedDocumentRequest.Builder setProcessedDocumentFormatValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for processedDocumentFormat to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setProcessedDocumentType(GetProcessedDocumentRequest.ProcessedDocumentType value)

public GetProcessedDocumentRequest.Builder setProcessedDocumentType(GetProcessedDocumentRequest.ProcessedDocumentType value)

Required. What type of processing to return.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value GetProcessedDocumentRequest.ProcessedDocumentType

The processedDocumentType to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setProcessedDocumentTypeValue(int value)

public GetProcessedDocumentRequest.Builder setProcessedDocumentTypeValue(int value)

Required. What type of processing to return.

.google.cloud.discoveryengine.v1alpha.GetProcessedDocumentRequest.ProcessedDocumentType processed_document_type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for processedDocumentType to set.

Returns
Type Description
GetProcessedDocumentRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GetProcessedDocumentRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GetProcessedDocumentRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GetProcessedDocumentRequest.Builder
Overrides