public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilder
Request message for
DocumentService.ListDocuments
method.
Protobuf type google.cloud.discoveryengine.v1.ListDocumentsRequest
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
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListDocumentsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListDocumentsRequest.Builder newBuilder()
newBuilder(ListDocumentsRequest prototype)
public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)
public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListDocumentsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListDocumentsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(CodedInputStream input)
public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(InputStream input)
public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListDocumentsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListDocumentsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListDocumentsRequest getDefaultInstanceForType()
getPageSize()
Maximum number of Documents to
return. If unspecified, defaults to 100. The maximum allowed value is 1000.
Values above 1000 are set to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
int32 page_size = 2;
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public String getPageToken()
A page token
ListDocumentsResponse.next_page_token,
received from a previous
DocumentService.ListDocuments
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
DocumentService.ListDocuments
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token
ListDocumentsResponse.next_page_token,
received from a previous
DocumentService.ListDocuments
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
DocumentService.ListDocuments
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParent()
public String getParent()
Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Use default_branch as the branch ID, to list documents under the default
branch.
If the caller does not have permission to list
Documents under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Use default_branch as the branch ID, to list documents under the default
branch.
If the caller does not have permission to list
Documents under this branch,
regardless of whether or not this branch exists, a PERMISSION_DENIED
error is returned.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListDocumentsRequest> getParserForType()
Overrides
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 ListDocumentsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListDocumentsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
