Class DescribeDatabaseEntitiesRequest.Builder (2.22.0)

public static final class DescribeDatabaseEntitiesRequest.Builder extends GeneratedMessageV3.Builder<DescribeDatabaseEntitiesRequest.Builder> implements DescribeDatabaseEntitiesRequestOrBuilder

Request message for 'DescribeDatabaseEntities' request.

Protobuf type google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest

Inheritance

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

Implements

DescribeDatabaseEntitiesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DescribeDatabaseEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DescribeDatabaseEntitiesRequest build()

Returns
Type	Description
`DescribeDatabaseEntitiesRequest`

buildPartial()

public DescribeDatabaseEntitiesRequest buildPartial()

Returns
Type	Description
`DescribeDatabaseEntitiesRequest`

clear()

public DescribeDatabaseEntitiesRequest.Builder clear()

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCommitId()

public DescribeDatabaseEntitiesRequest.Builder clearCommitId()

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

string commit_id = 12;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearConversionWorkspace()

public DescribeDatabaseEntitiesRequest.Builder clearConversionWorkspace()

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
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DescribeDatabaseEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public DescribeDatabaseEntitiesRequest.Builder clearFilter()

Filter the returned entities based on AIP-160 standard.

string filter = 13;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DescribeDatabaseEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageSize()

public DescribeDatabaseEntitiesRequest.Builder clearPageSize()

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

int32 page_size = 3;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearPageToken()

public DescribeDatabaseEntitiesRequest.Builder clearPageToken()

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;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearTree()

public DescribeDatabaseEntitiesRequest.Builder clearTree()

The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clearUncommitted()

public DescribeDatabaseEntitiesRequest.Builder clearUncommitted()

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;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

clone()

public DescribeDatabaseEntitiesRequest.Builder clone()

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCommitId()

public String getCommitId()

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

string commit_id = 12;

Returns
Type	Description
`String`	The commitId.

getCommitIdBytes()

public ByteString getCommitIdBytes()

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

string commit_id = 12;

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Filter the returned entities based on AIP-160 standard.

string filter = 13;

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter the returned entities based on AIP-160 standard.

string filter = 13;

Returns
Type	Description
`ByteString`	The bytes for filter.

getPageSize()

public int getPageSize()

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

int32 page_size = 3;

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

string page_token = 4;

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

string page_token = 4;

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getTree()

public DescribeDatabaseEntitiesRequest.DBTreeType getTree()

The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6;

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.DBTreeType`	The tree.

getTreeValue()

public int getTreeValue()

The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6;

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

getUncommitted()

public boolean getUncommitted()

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;

Returns
Type	Description
`boolean`	The uncommitted.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DescribeDatabaseEntitiesRequest other)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(DescribeDatabaseEntitiesRequest other)

Parameter
Name	Description
`other`	`DescribeDatabaseEntitiesRequest`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DescribeDatabaseEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCommitId(String value)

public DescribeDatabaseEntitiesRequest.Builder setCommitId(String value)

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

string commit_id = 12;

Parameter
Name	Description
`value`	`String` The commitId to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setCommitIdBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setCommitIdBytes(ByteString value)

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

string commit_id = 12;

Parameter
Name	Description
`value`	`ByteString` The bytes for commitId to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setConversionWorkspace(String value)

public DescribeDatabaseEntitiesRequest.Builder setConversionWorkspace(String value)

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

Parameter
Name	Description
`value`	`String` The conversionWorkspace to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setConversionWorkspaceBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setConversionWorkspaceBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for conversionWorkspace to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DescribeDatabaseEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public DescribeDatabaseEntitiesRequest.Builder setFilter(String value)

Filter the returned entities based on AIP-160 standard.

string filter = 13;

Parameter
Name	Description
`value`	`String` The filter to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setFilterBytes(ByteString value)

Filter the returned entities based on AIP-160 standard.

string filter = 13;

Parameter
Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setPageSize(int value)

public DescribeDatabaseEntitiesRequest.Builder setPageSize(int value)

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

int32 page_size = 3;

Parameter
Name	Description
`value`	`int` The pageSize to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setPageToken(String value)

public DescribeDatabaseEntitiesRequest.Builder setPageToken(String value)

string page_token = 4;

Parameter
Name	Description
`value`	`String` The pageToken to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setPageTokenBytes(ByteString value)

string page_token = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DescribeDatabaseEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTree(DescribeDatabaseEntitiesRequest.DBTreeType value)

public DescribeDatabaseEntitiesRequest.Builder setTree(DescribeDatabaseEntitiesRequest.DBTreeType value)

The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6;

Parameter
Name	Description
`value`	`DescribeDatabaseEntitiesRequest.DBTreeType` The tree to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setTreeValue(int value)

public DescribeDatabaseEntitiesRequest.Builder setTreeValue(int value)

The tree to fetch.

.google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest.DBTreeType tree = 6;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for tree to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setUncommitted(boolean value)

public DescribeDatabaseEntitiesRequest.Builder setUncommitted(boolean value)

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;

Parameter
Name	Description
`value`	`boolean` The uncommitted to set.

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DescribeDatabaseEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DescribeDatabaseEntitiesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)