Class DescribeDatabaseEntitiesRequest (2.44.0)

public final class DescribeDatabaseEntitiesRequest extends GeneratedMessageV3 implements DescribeDatabaseEntitiesRequestOrBuilder

Request message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DescribeDatabaseEntitiesRequest

Static Fields

COMMIT_ID_FIELD_NUMBER

public static final int COMMIT_ID_FIELD_NUMBER
Field Value
Type Description
int

CONVERSION_WORKSPACE_FIELD_NUMBER

public static final int CONVERSION_WORKSPACE_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

TREE_FIELD_NUMBER

public static final int TREE_FIELD_NUMBER
Field Value
Type Description
int

UNCOMMITTED_FIELD_NUMBER

public static final int UNCOMMITTED_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DescribeDatabaseEntitiesRequest getDefaultInstance()
Returns
Type Description
DescribeDatabaseEntitiesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DescribeDatabaseEntitiesRequest.Builder newBuilder()
Returns
Type Description
DescribeDatabaseEntitiesRequest.Builder

newBuilder(DescribeDatabaseEntitiesRequest prototype)

public static DescribeDatabaseEntitiesRequest.Builder newBuilder(DescribeDatabaseEntitiesRequest prototype)
Parameter
Name Description
prototype DescribeDatabaseEntitiesRequest
Returns
Type Description
DescribeDatabaseEntitiesRequest.Builder

parseDelimitedFrom(InputStream input)

public static DescribeDatabaseEntitiesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DescribeDatabaseEntitiesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DescribeDatabaseEntitiesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DescribeDatabaseEntitiesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DescribeDatabaseEntitiesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DescribeDatabaseEntitiesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DescribeDatabaseEntitiesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DescribeDatabaseEntitiesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DescribeDatabaseEntitiesRequest> parser()
Returns
Type Description
Parser<DescribeDatabaseEntitiesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCommitId()

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

getDefaultInstanceForType()

public DescribeDatabaseEntitiesRequest getDefaultInstanceForType()
Returns
Type Description
DescribeDatabaseEntitiesRequest

getFilter()

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

getParserForType()

public Parser<DescribeDatabaseEntitiesRequest> getParserForType()
Returns
Type Description
Parser<DescribeDatabaseEntitiesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTree()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DescribeDatabaseEntitiesRequest.Builder newBuilderForType()
Returns
Type Description
DescribeDatabaseEntitiesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DescribeDatabaseEntitiesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DescribeDatabaseEntitiesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DescribeDatabaseEntitiesRequest.Builder toBuilder()
Returns
Type Description
DescribeDatabaseEntitiesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException