Class DataProfileSpec.SelectedFields.Builder (1.43.0)

public static final class DataProfileSpec.SelectedFields.Builder extends GeneratedMessageV3.Builder<DataProfileSpec.SelectedFields.Builder> implements DataProfileSpec.SelectedFieldsOrBuilder

The specification for fields to include or exclude in data profile scan.

Protobuf type google.cloud.dataplex.v1.DataProfileSpec.SelectedFields

Static Methods

getDescriptor()

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

Methods

addAllFieldNames(Iterable<String> values)

public DataProfileSpec.SelectedFields.Builder addAllFieldNames(Iterable<String> values)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Parameter
Name Description
values Iterable<String>

The fieldNames to add.

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

This builder for chaining.

addFieldNames(String value)

public DataProfileSpec.SelectedFields.Builder addFieldNames(String value)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Parameter
Name Description
value String

The fieldNames to add.

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

This builder for chaining.

addFieldNamesBytes(ByteString value)

public DataProfileSpec.SelectedFields.Builder addFieldNamesBytes(ByteString value)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Parameter
Name Description
value ByteString

The bytes of the fieldNames to add.

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public DataProfileSpec.SelectedFields build()
Returns
Type Description
DataProfileSpec.SelectedFields

buildPartial()

public DataProfileSpec.SelectedFields buildPartial()
Returns
Type Description
DataProfileSpec.SelectedFields

clear()

public DataProfileSpec.SelectedFields.Builder clear()
Returns
Type Description
DataProfileSpec.SelectedFields.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearFieldNames()

public DataProfileSpec.SelectedFields.Builder clearFieldNames()

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public DataProfileSpec.SelectedFields.Builder clone()
Returns
Type Description
DataProfileSpec.SelectedFields.Builder
Overrides

getDefaultInstanceForType()

public DataProfileSpec.SelectedFields getDefaultInstanceForType()
Returns
Type Description
DataProfileSpec.SelectedFields

getDescriptorForType()

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

getFieldNames(int index)

public String getFieldNames(int index)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The fieldNames at the given index.

getFieldNamesBytes(int index)

public ByteString getFieldNamesBytes(int index)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

repeated string field_names = 1 [(.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 fieldNames at the given index.

getFieldNamesCount()

public int getFieldNamesCount()

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Returns
Type Description
int

The count of fieldNames.

getFieldNamesList()

public ProtocolStringList getFieldNamesList()

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Returns
Type Description
ProtocolStringList

A list containing the fieldNames.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DataProfileSpec.SelectedFields other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldNames(int index, String value)

public DataProfileSpec.SelectedFields.Builder setFieldNames(int index, String value)

Optional. Expected input is a list of fully qualified names of fields as in the schema.

Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'.

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

Parameters
Name Description
index int

The index to set the value at.

value String

The fieldNames to set.

Returns
Type Description
DataProfileSpec.SelectedFields.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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