com.google.cloud.discoveryengine.v1

Class GetDocumentRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>

com.google.cloud.discoveryengine.v1.GetDocumentRequest.Builder

All Implemented Interfaces:

GetDocumentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GetDocumentRequest

public static final class GetDocumentRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>
implements GetDocumentRequestOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1.GetDocumentRequest

Method Summary

Modifier and Type	Method and Description
GetDocumentRequest	build()
GetDocumentRequest	buildPartial()
GetDocumentRequest.Builder	clear()
GetDocumentRequest.Builder	clearName() Required.
GetDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GetDocumentRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GetDocumentRequest.Builder	mergeFrom(GetDocumentRequest other)
GetDocumentRequest.Builder	mergeFrom(com.google.protobuf.Message other)
GetDocumentRequest.Builder	setName(String value) Required.
GetDocumentRequest.Builder	setNameBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>

clear

public GetDocumentRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>

getDefaultInstanceForType

public GetDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GetDocumentRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GetDocumentRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public GetDocumentRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>

mergeFrom

public GetDocumentRequest.Builder mergeFrom(GetDocumentRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GetDocumentRequest.Builder>

mergeFrom

public GetDocumentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GetDocumentRequest.Builder>

Throws:

IOException

getName

public String getName()

 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1.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.v1.Document], regardless of whether
 or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1.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 GetDocumentRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1.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.v1.Document], regardless of whether
 or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1.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 GetDocumentRequestOrBuilder

Returns:

The bytes for name.

setName

public GetDocumentRequest.Builder setName(String value)

 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1.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.v1.Document], regardless of whether
 or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1.Document] does
 not exist, a `NOT_FOUND` error is returned.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public GetDocumentRequest.Builder clearName()

 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1.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.v1.Document], regardless of whether
 or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1.Document] does
 not exist, a `NOT_FOUND` error is returned.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setNameBytes

public GetDocumentRequest.Builder setNameBytes(com.google.protobuf.ByteString value)

 Required. Full resource name of
 [Document][google.cloud.discoveryengine.v1.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.v1.Document], regardless of whether
 or not it exists, a `PERMISSION_DENIED` error is returned.

 If the requested [Document][google.cloud.discoveryengine.v1.Document] does
 not exist, a `NOT_FOUND` error is returned.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.