ListDocumentsRequest (gpdb20160503 3.0.0 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.gpdb20160503.models.ListDocumentsRequest

public class ListDocumentsRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`collection` The name of the document collection.
`String`	`DBInstanceId` This parameter is required.
`Integer`	`maxResults` The maximum number of entries per page.
`String`	`namespace` The name of the namespace.
`String`	`namespacePassword` The password of the namespace.
`String`	`nextToken` The pagination token that is used in the next request to retrieve a new page of results.
`Long`	`ownerId`
`String`	`regionId` The region ID of the instance.

构造器概要

构造器
构造器和说明

ListDocumentsRequest()

构造器
构造器和说明
`ListDocumentsRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static ListDocumentsRequest`	`build(Map<String,?> map)`
`String`	`getCollection()`
`String`	`getDBInstanceId()`
`Integer`	`getMaxResults()`
`String`	`getNamespace()`
`String`	`getNamespacePassword()`
`String`	`getNextToken()`
`Long`	`getOwnerId()`
`String`	`getRegionId()`
`ListDocumentsRequest`	`setCollection(String collection)`
`ListDocumentsRequest`	`setDBInstanceId(String DBInstanceId)`
`ListDocumentsRequest`	`setMaxResults(Integer maxResults)`
`ListDocumentsRequest`	`setNamespace(String namespace)`
`ListDocumentsRequest`	`setNamespacePassword(String namespacePassword)`
`ListDocumentsRequest`	`setNextToken(String nextToken)`
`ListDocumentsRequest`	`setOwnerId(Long ownerId)`
`ListDocumentsRequest`	`setRegionId(String regionId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - collection
```
@NameInMap(value="Collection")
public String collection
```
    The name of the document collection.
    
    You can call the CreateDocumentCollection operation to create a document collection and call the ListDocumentCollections operation to query a list of document collections.
    
    This parameter is required.
    example:
    document
  - DBInstanceId
```
@NameInMap(value="DBInstanceId")
public String DBInstanceId
```
    This parameter is required.
    example:
    gp-xxxxxxxxx
  - maxResults
```
@NameInMap(value="MaxResults")
public Integer maxResults
```
    The maximum number of entries per page. Valid values: 1 to 100.
    example:
    100
  - namespace
```
@NameInMap(value="Namespace")
public String namespace
```
    The name of the namespace. Default value: public.
    
    You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.
    
    example:
    mynamespace
  - namespacePassword
```
@NameInMap(value="NamespacePassword")
public String namespacePassword
```
    The password of the namespace.
    
    This value is specified when you call the CreateNamespace operation.
    
    This parameter is required.
    example:
    testpassword
  - nextToken
```
@NameInMap(value="NextToken")
public String nextToken
```
    The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.
    example:
    caeba0bbb2be03f84eb48b699f0a4883
  - ownerId
```
@NameInMap(value="OwnerId")
public Long ownerId
```
  - regionId
```
@NameInMap(value="RegionId")
public String regionId
```
    The region ID of the instance.
    
    This parameter is required.
    example:
    cn-hangzhou
- 构造器详细资料
  - ListDocumentsRequest
```
public ListDocumentsRequest()
```
- 方法详细资料
  - build
```
public static ListDocumentsRequest build(Map<String,?> map)
                                  throws Exception
```
    抛出:
    
    Exception
  - setCollection
```
public ListDocumentsRequest setCollection(String collection)
```
  - getCollection
```
public String getCollection()
```
  - setDBInstanceId
```
public ListDocumentsRequest setDBInstanceId(String DBInstanceId)
```
  - getDBInstanceId
```
public String getDBInstanceId()
```
  - setMaxResults
```
public ListDocumentsRequest setMaxResults(Integer maxResults)
```
  - getMaxResults
```
public Integer getMaxResults()
```
  - setNamespace
```
public ListDocumentsRequest setNamespace(String namespace)
```
  - getNamespace
```
public String getNamespace()
```
  - setNamespacePassword
```
public ListDocumentsRequest setNamespacePassword(String namespacePassword)
```
  - getNamespacePassword
```
public String getNamespacePassword()
```
  - setNextToken
```
public ListDocumentsRequest setNextToken(String nextToken)
```
  - getNextToken
```
public String getNextToken()
```
  - setOwnerId
```
public ListDocumentsRequest setOwnerId(Long ownerId)
```
  - getOwnerId
```
public Long getOwnerId()
```
  - setRegionId
```
public ListDocumentsRequest setRegionId(String regionId)
```
  - getRegionId
```
public String getRegionId()
```

类 ListDocumentsRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

collection

DBInstanceId

maxResults

namespace

namespacePassword

nextToken

ownerId

regionId

构造器详细资料

ListDocumentsRequest

方法详细资料

build

setCollection

getCollection

setDBInstanceId

getDBInstanceId

setMaxResults

getMaxResults

setNamespace

getNamespace

setNamespacePassword

getNamespacePassword

setNextToken

getNextToken

setOwnerId

getOwnerId

setRegionId

getRegionId