DescribeDatabaseEntitiesRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Request message for 'DescribeDatabaseEntities' request.
Attributes | |
|---|---|
| Name | Description |
conversion_workspace |
str
Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. |
page_size |
int
Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies. |
page_token |
str
Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token. |
tree |
google.cloud.clouddms_v1.types.DescribeDatabaseEntitiesRequest.DBTreeType
Required. The tree to fetch. |
uncommitted |
bool
Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified. |
commit_id |
str
Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned. |
filter |
str
Optional. Filter the returned entities based on AIP-160 standard. |
view |
google.cloud.clouddms_v1.types.DatabaseEntityView
Optional. Results view based on AIP-157 |
Classes
DBTreeType
DBTreeType(value)The type of a tree to return
Values: DB_TREE_TYPE_UNSPECIFIED (0): Unspecified tree type. SOURCE_TREE (1): The source database tree. DRAFT_TREE (2): The draft database tree. DESTINATION_TREE (3): The destination database tree.