Class MappingRuleFilter.Builder (2.42.0)

public static final class MappingRuleFilter.Builder extends GeneratedMessageV3.Builder<MappingRuleFilter.Builder> implements MappingRuleFilterOrBuilder

A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields.

Protobuf type google.cloud.clouddms.v1.MappingRuleFilter

Static Methods

getDescriptor()

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

Methods

addAllEntities(Iterable<String> values)

public MappingRuleFilter.Builder addAllEntities(Iterable<String> values)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The entities to add.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

addEntities(String value)

public MappingRuleFilter.Builder addEntities(String value)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The entities to add.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

addEntitiesBytes(ByteString value)

public MappingRuleFilter.Builder addEntitiesBytes(ByteString value)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the entities to add.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MappingRuleFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MappingRuleFilter.Builder
Overrides

build()

public MappingRuleFilter build()
Returns
Type Description
MappingRuleFilter

buildPartial()

public MappingRuleFilter buildPartial()
Returns
Type Description
MappingRuleFilter

clear()

public MappingRuleFilter.Builder clear()
Returns
Type Description
MappingRuleFilter.Builder
Overrides

clearEntities()

public MappingRuleFilter.Builder clearEntities()

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

clearEntityNameContains()

public MappingRuleFilter.Builder clearEntityNameContains()

Optional. The rule should be applied to entities whose non-qualified name contains the given string.

string entity_name_contains = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

clearEntityNamePrefix()

public MappingRuleFilter.Builder clearEntityNamePrefix()

Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.

string entity_name_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

clearEntityNameSuffix()

public MappingRuleFilter.Builder clearEntityNameSuffix()

Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.

string entity_name_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MappingRuleFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
MappingRuleFilter.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public MappingRuleFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
MappingRuleFilter.Builder
Overrides

clearParentEntity()

public MappingRuleFilter.Builder clearParentEntity()

Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)

string parent_entity = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

clone()

public MappingRuleFilter.Builder clone()
Returns
Type Description
MappingRuleFilter.Builder
Overrides

getDefaultInstanceForType()

public MappingRuleFilter getDefaultInstanceForType()
Returns
Type Description
MappingRuleFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEntities(int index)

public String getEntities(int index)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The entities at the given index.

getEntitiesBytes(int index)

public ByteString getEntitiesBytes(int index)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the entities at the given index.

getEntitiesCount()

public int getEntitiesCount()

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of entities.

getEntitiesList()

public ProtocolStringList getEntitiesList()

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the entities.

getEntityNameContains()

public String getEntityNameContains()

Optional. The rule should be applied to entities whose non-qualified name contains the given string.

string entity_name_contains = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The entityNameContains.

getEntityNameContainsBytes()

public ByteString getEntityNameContainsBytes()

Optional. The rule should be applied to entities whose non-qualified name contains the given string.

string entity_name_contains = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for entityNameContains.

getEntityNamePrefix()

public String getEntityNamePrefix()

Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.

string entity_name_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The entityNamePrefix.

getEntityNamePrefixBytes()

public ByteString getEntityNamePrefixBytes()

Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.

string entity_name_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for entityNamePrefix.

getEntityNameSuffix()

public String getEntityNameSuffix()

Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.

string entity_name_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The entityNameSuffix.

getEntityNameSuffixBytes()

public ByteString getEntityNameSuffixBytes()

Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.

string entity_name_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for entityNameSuffix.

getParentEntity()

public String getParentEntity()

Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)

string parent_entity = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The parentEntity.

getParentEntityBytes()

public ByteString getParentEntityBytes()

Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)

string parent_entity = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for parentEntity.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MappingRuleFilter other)

public MappingRuleFilter.Builder mergeFrom(MappingRuleFilter other)
Parameter
Name Description
other MappingRuleFilter
Returns
Type Description
MappingRuleFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MappingRuleFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MappingRuleFilter.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MappingRuleFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MappingRuleFilter.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MappingRuleFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MappingRuleFilter.Builder
Overrides

setEntities(int index, String value)

public MappingRuleFilter.Builder setEntities(int index, String value)

Optional. The rule should be applied to specific entities defined by their fully qualified names.

repeated string entities = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The entities to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNameContains(String value)

public MappingRuleFilter.Builder setEntityNameContains(String value)

Optional. The rule should be applied to entities whose non-qualified name contains the given string.

string entity_name_contains = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The entityNameContains to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNameContainsBytes(ByteString value)

public MappingRuleFilter.Builder setEntityNameContainsBytes(ByteString value)

Optional. The rule should be applied to entities whose non-qualified name contains the given string.

string entity_name_contains = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for entityNameContains to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNamePrefix(String value)

public MappingRuleFilter.Builder setEntityNamePrefix(String value)

Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.

string entity_name_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The entityNamePrefix to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNamePrefixBytes(ByteString value)

public MappingRuleFilter.Builder setEntityNamePrefixBytes(ByteString value)

Optional. The rule should be applied to entities whose non-qualified name starts with the given prefix.

string entity_name_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for entityNamePrefix to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNameSuffix(String value)

public MappingRuleFilter.Builder setEntityNameSuffix(String value)

Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.

string entity_name_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The entityNameSuffix to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setEntityNameSuffixBytes(ByteString value)

public MappingRuleFilter.Builder setEntityNameSuffixBytes(ByteString value)

Optional. The rule should be applied to entities whose non-qualified name ends with the given suffix.

string entity_name_suffix = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for entityNameSuffix to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MappingRuleFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
MappingRuleFilter.Builder
Overrides

setParentEntity(String value)

public MappingRuleFilter.Builder setParentEntity(String value)

Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)

string parent_entity = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The parentEntity to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

setParentEntityBytes(ByteString value)

public MappingRuleFilter.Builder setParentEntityBytes(ByteString value)

Optional. The rule should be applied to entities whose parent entity (fully qualified name) matches the given value. For example, if the rule applies to a table entity, the expected value should be a schema (schema). If the rule applies to a column or index entity, the expected value can be either a schema (schema) or a table (schema.table)

string parent_entity = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for parentEntity to set.

Returns
Type Description
MappingRuleFilter.Builder

This builder for chaining.

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

public MappingRuleFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
MappingRuleFilter.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final MappingRuleFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
MappingRuleFilter.Builder
Overrides