com.google.cloud.clouddms.v1

Class DescribeDatabaseEntitiesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

All Implemented Interfaces:

DescribeDatabaseEntitiesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DescribeDatabaseEntitiesRequest
extends com.google.protobuf.GeneratedMessageV3
implements DescribeDatabaseEntitiesRequestOrBuilder

 Request message for 'DescribeDatabaseEntities' request.
 

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescribeDatabaseEntitiesRequest.Builder Request message for 'DescribeDatabaseEntities' request.
static class	DescribeDatabaseEntitiesRequest.DBTreeType The type of a tree to return

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMIT_ID_FIELD_NUMBER
static int	CONVERSION_WORKSPACE_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	TREE_FIELD_NUMBER
static int	UNCOMMITTED_FIELD_NUMBER
static int	VIEW_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCommitId() Optional.
com.google.protobuf.ByteString	getCommitIdBytes() Optional.
String	getConversionWorkspace() Required.
com.google.protobuf.ByteString	getConversionWorkspaceBytes() Required.
static DescribeDatabaseEntitiesRequest	getDefaultInstance()
DescribeDatabaseEntitiesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
com.google.protobuf.Parser<DescribeDatabaseEntitiesRequest>	getParserForType()
int	getSerializedSize()
DescribeDatabaseEntitiesRequest.DBTreeType	getTree() Required.
int	getTreeValue() Required.
boolean	getUncommitted() Optional.
DatabaseEntityView	getView() Optional.
int	getViewValue() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DescribeDatabaseEntitiesRequest.Builder	newBuilder()
static DescribeDatabaseEntitiesRequest.Builder	newBuilder(DescribeDatabaseEntitiesRequest prototype)
DescribeDatabaseEntitiesRequest.Builder	newBuilderForType()
protected DescribeDatabaseEntitiesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DescribeDatabaseEntitiesRequest	parseDelimitedFrom(InputStream input)
static DescribeDatabaseEntitiesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeDatabaseEntitiesRequest	parseFrom(byte[] data)
static DescribeDatabaseEntitiesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeDatabaseEntitiesRequest	parseFrom(ByteBuffer data)
static DescribeDatabaseEntitiesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeDatabaseEntitiesRequest	parseFrom(com.google.protobuf.ByteString data)
static DescribeDatabaseEntitiesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeDatabaseEntitiesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static DescribeDatabaseEntitiesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DescribeDatabaseEntitiesRequest	parseFrom(InputStream input)
static DescribeDatabaseEntitiesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DescribeDatabaseEntitiesRequest>	parser()
DescribeDatabaseEntitiesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONVERSION_WORKSPACE_FIELD_NUMBER

public static final int CONVERSION_WORKSPACE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

TREE_FIELD_NUMBER

public static final int TREE_FIELD_NUMBER

See Also:

Constant Field Values

UNCOMMITTED_FIELD_NUMBER

public static final int UNCOMMITTED_FIELD_NUMBER

See Also:

Constant Field Values

COMMIT_ID_FIELD_NUMBER

public static final int COMMIT_ID_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:

getConversionWorkspace in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The conversionWorkspace.

getConversionWorkspaceBytes

public 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) = { ... }

Specified by:

getConversionWorkspaceBytes in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The bytes for conversionWorkspace.

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];

Specified by:

getPageSize in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

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];

Specified by:

getPageToken in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public 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];

Specified by:

getPageTokenBytes in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The bytes for pageToken.

getTreeValue

public int getTreeValue()

 Required. The tree to fetch.
 

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

Specified by:

getTreeValue in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The enum numeric value on the wire for tree.

getTree

public DescribeDatabaseEntitiesRequest.DBTreeType getTree()

 Required. The tree to fetch.
 

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

Specified by:

getTree in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The 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];

Specified by:

getUncommitted in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The uncommitted.

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];

Specified by:

getCommitId in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The commitId.

getCommitIdBytes

public 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];

Specified by:

getCommitIdBytes in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The bytes for commitId.

getFilter

public String getFilter()

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

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

Specified by:

getFilter in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

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

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

Specified by:

getFilterBytes in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The bytes for filter.

getViewValue

public int getViewValue()

 Optional. Results view based on AIP-157
 

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

Specified by:

getViewValue in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The enum numeric value on the wire for view.

getView

public DatabaseEntityView getView()

 Optional. Results view based on AIP-157
 

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

Specified by:

getView in interface DescribeDatabaseEntitiesRequestOrBuilder

Returns:

The view.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static DescribeDatabaseEntitiesRequest parseDelimitedFrom(InputStream input)
                                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static DescribeDatabaseEntitiesRequest parseDelimitedFrom(InputStream input,
                                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                          throws IOException

Throws:

IOException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static DescribeDatabaseEntitiesRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

newBuilderForType

public DescribeDatabaseEntitiesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DescribeDatabaseEntitiesRequest.Builder newBuilder()

newBuilder

public static DescribeDatabaseEntitiesRequest.Builder newBuilder(DescribeDatabaseEntitiesRequest prototype)

toBuilder

public DescribeDatabaseEntitiesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DescribeDatabaseEntitiesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DescribeDatabaseEntitiesRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<DescribeDatabaseEntitiesRequest> parser()

getParserForType

public com.google.protobuf.Parser<DescribeDatabaseEntitiesRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DescribeDatabaseEntitiesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder