Interface DescribeDatabaseEntitiesRequestOrBuilder (2.26.0)

Version 2.26.0

• 2.52.0 (latest)
• 2.51.0
• 2.50.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.8
• 2.1.9

public interface DescribeDatabaseEntitiesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCommitId()

public abstract String getCommitId()

Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The commitId.

getCommitIdBytes()

public abstract ByteString getCommitIdBytes()

Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

string commit_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for commitId.

getConversionWorkspace()

public abstract String getConversionWorkspace()

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}.

string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The conversionWorkspace.

getConversionWorkspaceBytes()

public abstract ByteString getConversionWorkspaceBytes()

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}.

string conversion_workspace = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for conversionWorkspace.

getFilter()

public abstract String getFilter()

Optional. Filter the returned entities based on AIP-160 standard.

string filter = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. Filter the returned entities based on AIP-160 standard.

string filter = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String getPageToken()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getTree()

public abstract DescribeDatabaseEntitiesRequest.DBTreeType getTree()

Required. The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
DescribeDatabaseEntitiesRequest.DBTreeType	The tree.

getTreeValue()

public abstract int getTreeValue()

Required. The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for tree.

getUncommitted()

public abstract boolean getUncommitted()

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.

bool uncommitted = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The uncommitted.

getView()

public abstract DatabaseEntityView getView()

Optional. Results view based on AIP-157

.google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
DatabaseEntityView	The view.

getViewValue()

public abstract int getViewValue()

Optional. Results view based on AIP-157

.google.cloud.clouddms.v1.DatabaseEntityView view = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for view.