com.aliyun.gpdb20160503.models

类 DescribeDocumentRequest

java.lang.Object

com.aliyun.tea.TeaModel

com.aliyun.gpdb20160503.models.DescribeDocumentRequest

public class DescribeDocumentRequest
extends com.aliyun.tea.TeaModel

字段概要

字段

限定符和类型	字段和说明
String	collection The name of the document collection.
String	DBInstanceId This parameter is required.
String	fileName The name of the document.
String	namespace The name of the namespace.
String	namespacePassword The password of the namespace.
Long	ownerId
String	regionId This parameter is required.

构造器概要

构造器

构造器和说明
DescribeDocumentRequest()

方法概要

限定符和类型	方法和说明
static DescribeDocumentRequest	build(Map<String,?> map)
String	getCollection()
String	getDBInstanceId()
String	getFileName()
String	getNamespace()
String	getNamespacePassword()
Long	getOwnerId()
String	getRegionId()
DescribeDocumentRequest	setCollection(String collection)
DescribeDocumentRequest	setDBInstanceId(String DBInstanceId)
DescribeDocumentRequest	setFileName(String fileName)
DescribeDocumentRequest	setNamespace(String namespace)
DescribeDocumentRequest	setNamespacePassword(String namespacePassword)
DescribeDocumentRequest	setOwnerId(Long ownerId)
DescribeDocumentRequest	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

fileName

@NameInMap(value="FileName")
public String fileName

The name of the document.

You can call the ListDocuments operation to query a list of documents.

This parameter is required.

example:

music.txt

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

ownerId

@NameInMap(value="OwnerId")
public Long ownerId

regionId

@NameInMap(value="RegionId")
public String regionId

This parameter is required.

example:

cn-hangzhou

构造器详细资料

DescribeDocumentRequest

public DescribeDocumentRequest()

方法详细资料

build

public static DescribeDocumentRequest build(Map<String,?> map)
                                     throws Exception

抛出:

Exception

setCollection

public DescribeDocumentRequest setCollection(String collection)

getCollection

public String getCollection()

setDBInstanceId

public DescribeDocumentRequest setDBInstanceId(String DBInstanceId)

getDBInstanceId

public String getDBInstanceId()

setFileName

public DescribeDocumentRequest setFileName(String fileName)

getFileName

public String getFileName()

setNamespace

public DescribeDocumentRequest setNamespace(String namespace)

getNamespace

public String getNamespace()

setNamespacePassword

public DescribeDocumentRequest setNamespacePassword(String namespacePassword)

getNamespacePassword

public String getNamespacePassword()

setOwnerId

public DescribeDocumentRequest setOwnerId(Long ownerId)

getOwnerId

public Long getOwnerId()

setRegionId

public DescribeDocumentRequest setRegionId(String regionId)

getRegionId

public String getRegionId()