- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilderRequest message for DocumentService.ListDocuments method.
Protobuf type google.cloud.discoveryengine.v1beta.ListDocumentsRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ListDocumentsRequestImplements
ListDocumentsRequestOrBuilderStatic Fields
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER| Type | Description |
| int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER| Type | Description |
| int |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
public static ListDocumentsRequest getDefaultInstance()| Type | Description |
| ListDocumentsRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
newBuilder()
public static ListDocumentsRequest.Builder newBuilder()| Type | Description |
| ListDocumentsRequest.Builder |
newBuilder(ListDocumentsRequest prototype)
public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)| Name | Description |
| prototype | ListDocumentsRequest |
| Type | Description |
| ListDocumentsRequest.Builder |
parseDelimitedFrom(InputStream input)
public static ListDocumentsRequest parseDelimitedFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseFrom(byte[] data)
public static ListDocumentsRequest parseFrom(byte[] data)| Name | Description |
| data | byte[] |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ListDocumentsRequest parseFrom(ByteString data)| Name | Description |
| data | ByteString |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ListDocumentsRequest parseFrom(CodedInputStream input)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input)
public static ListDocumentsRequest parseFrom(InputStream input)| Name | Description |
| input | InputStream |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
public static ListDocumentsRequest parseFrom(ByteBuffer data)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListDocumentsRequest |
| Type | Description |
| InvalidProtocolBufferException |
parser()
public static Parser<ListDocumentsRequest> parser()| Type | Description |
| Parser<ListDocumentsRequest> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getDefaultInstanceForType()
public ListDocumentsRequest getDefaultInstanceForType()| Type | Description |
| ListDocumentsRequest |
getPageSize()
public int getPageSize()Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is
- Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
int32 page_size = 2;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for pageToken. |
getParent()
public String getParent() Required. The parent branch resource name, such as
projects/{project}/locations/{location}/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][]s 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) = { ... }
| Type | Description |
| String | The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The parent branch resource name, such as
projects/{project}/locations/{location}/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][]s 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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
getParserForType()
public Parser<ListDocumentsRequest> getParserForType()| Type | Description |
| Parser<ListDocumentsRequest> |
getSerializedSize()
public int getSerializedSize()| Type | Description |
| int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
newBuilderForType()
public ListDocumentsRequest.Builder newBuilderForType()| Type | Description |
| ListDocumentsRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| ListDocumentsRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
public ListDocumentsRequest.Builder toBuilder()| Type | Description |
| ListDocumentsRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |