Package com.google.cloud.clouddms.v1

Interface DescribeDatabaseEntitiesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DescribeDatabaseEntitiesRequest, DescribeDatabaseEntitiesRequest.Builder

public interface DescribeDatabaseEntitiesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
String	getCommitId()	Optional.
com.google.protobuf.ByteString	getCommitIdBytes()	Optional.
String	getConversionWorkspace()	Required.
com.google.protobuf.ByteString	getConversionWorkspaceBytes()	Required.
String	getFilter()	Optional.
com.google.protobuf.ByteString	getFilterBytes()	Optional.
int	getPageSize()	Optional.
String	getPageToken()	Optional.
com.google.protobuf.ByteString	getPageTokenBytes()	Optional.
DescribeDatabaseEntitiesRequest.DBTreeType	getTree()	Required.
int	getTreeValue()	Required.
boolean	getUncommitted()	Optional.
DatabaseEntityView	getView()	Optional.
int	getViewValue()	Optional.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getConversionWorkspace

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:

The conversionWorkspace.

getConversionWorkspaceBytes

com.google.protobuf.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:

The bytes for conversionWorkspace.

getPageSize

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:

The pageSize.

getPageToken

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:

The pageToken.

getPageTokenBytes

com.google.protobuf.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:

The bytes for pageToken.

getTreeValue

int getTreeValue()

 Required. The tree to fetch.
 

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

Returns:

The enum numeric value on the wire for tree.

getTree

DescribeDatabaseEntitiesRequest.DBTreeType getTree()

 Required. The tree to fetch.
 

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

Returns:

The tree.

getUncommitted

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:

The uncommitted.

getCommitId

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:

The commitId.

getCommitIdBytes

com.google.protobuf.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:

The bytes for commitId.

getFilter

String getFilter()

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

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

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

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

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

Returns:

The bytes for filter.

getViewValue

int getViewValue()

 Optional. Results view based on AIP-157
 

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

Returns:

The enum numeric value on the wire for view.

getView

DatabaseEntityView getView()

 Optional. Results view based on AIP-157
 

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

Returns:

The view.