Class DescribeDatabaseEntitiesRequest.Builder (2.39.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DescribeDatabaseEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

build()

public DescribeDatabaseEntitiesRequest build()
Returns
TypeDescription
DescribeDatabaseEntitiesRequest

buildPartial()

public DescribeDatabaseEntitiesRequest buildPartial()
Returns
TypeDescription
DescribeDatabaseEntitiesRequest

clear()

public DescribeDatabaseEntitiesRequest.Builder clear()
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

clearCommitId()

public DescribeDatabaseEntitiesRequest.Builder clearCommitId()

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
TypeDescription
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
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DescribeDatabaseEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

clearFilter()

public DescribeDatabaseEntitiesRequest.Builder clearFilter()

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

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

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DescribeDatabaseEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

clearPageSize()

public DescribeDatabaseEntitiesRequest.Builder clearPageSize()

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
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearPageToken()

public DescribeDatabaseEntitiesRequest.Builder clearPageToken()

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
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearTree()

public DescribeDatabaseEntitiesRequest.Builder clearTree()

Required. The tree to fetch.

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

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearUncommitted()

public DescribeDatabaseEntitiesRequest.Builder clearUncommitted()

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
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clearView()

public DescribeDatabaseEntitiesRequest.Builder clearView()

Optional. Results view based on AIP-157

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

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

clone()

public DescribeDatabaseEntitiesRequest.Builder clone()
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for conversionWorkspace.

getDefaultInstanceForType()

public DescribeDatabaseEntitiesRequest getDefaultInstanceForType()
Returns
TypeDescription
DescribeDatabaseEntitiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for pageToken.

getTree()

public DescribeDatabaseEntitiesRequest.DBTreeType getTree()

Required. The tree to fetch.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for view.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DescribeDatabaseEntitiesRequest other)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(DescribeDatabaseEntitiesRequest other)
Parameter
NameDescription
otherDescribeDatabaseEntitiesRequest
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DescribeDatabaseEntitiesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DescribeDatabaseEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

setCommitId(String value)

public DescribeDatabaseEntitiesRequest.Builder setCommitId(String value)

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

Parameter
NameDescription
valueString

The commitId to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setCommitIdBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setCommitIdBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for commitId to set.

Returns
TypeDescription
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
NameDescription
valueString

The conversionWorkspace to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for conversionWorkspace to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DescribeDatabaseEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

setFilter(String value)

public DescribeDatabaseEntitiesRequest.Builder setFilter(String value)

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

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

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setFilterBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setPageSize(int value)

public DescribeDatabaseEntitiesRequest.Builder setPageSize(int value)

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setPageToken(String value)

public DescribeDatabaseEntitiesRequest.Builder setPageToken(String value)

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public DescribeDatabaseEntitiesRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

setTree(DescribeDatabaseEntitiesRequest.DBTreeType value)

public DescribeDatabaseEntitiesRequest.Builder setTree(DescribeDatabaseEntitiesRequest.DBTreeType value)

Required. The tree to fetch.

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

Parameter
NameDescription
valueDescribeDatabaseEntitiesRequest.DBTreeType

The tree to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setTreeValue(int value)

public DescribeDatabaseEntitiesRequest.Builder setTreeValue(int value)

Required. The tree to fetch.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for tree to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setUncommitted(boolean value)

public DescribeDatabaseEntitiesRequest.Builder setUncommitted(boolean value)

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

Parameter
NameDescription
valueboolean

The uncommitted to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DescribeDatabaseEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder
Overrides

setView(DatabaseEntityView value)

public DescribeDatabaseEntitiesRequest.Builder setView(DatabaseEntityView value)

Optional. Results view based on AIP-157

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

Parameter
NameDescription
valueDatabaseEntityView

The view to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.

setViewValue(int value)

public DescribeDatabaseEntitiesRequest.Builder setViewValue(int value)

Optional. Results view based on AIP-157

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for view to set.

Returns
TypeDescription
DescribeDatabaseEntitiesRequest.Builder

This builder for chaining.