Class AspectType.MetadataTemplate.Annotations.Builder (1.44.0)

public static final class AspectType.MetadataTemplate.Annotations.Builder extends GeneratedMessageV3.Builder<AspectType.MetadataTemplate.Annotations.Builder> implements AspectType.MetadataTemplate.AnnotationsOrBuilder

Definition of the annotations of a field

Protobuf type google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations

Static Methods

getDescriptor()

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

Methods

addAllStringValues(Iterable<String> values)

public AspectType.MetadataTemplate.Annotations.Builder addAllStringValues(Iterable<String> values)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The stringValues to add.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addStringValues(String value)

public AspectType.MetadataTemplate.Annotations.Builder addStringValues(String value)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The stringValues to add.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

addStringValuesBytes(ByteString value)

public AspectType.MetadataTemplate.Annotations.Builder addStringValuesBytes(ByteString value)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the stringValues to add.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

build()

public AspectType.MetadataTemplate.Annotations build()
Returns
Type Description
AspectType.MetadataTemplate.Annotations

buildPartial()

public AspectType.MetadataTemplate.Annotations buildPartial()
Returns
Type Description
AspectType.MetadataTemplate.Annotations

clear()

public AspectType.MetadataTemplate.Annotations.Builder clear()
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

clearDeprecated()

public AspectType.MetadataTemplate.Annotations.Builder clearDeprecated()

Optional. Marks a field as deprecated, a deprecation message can be included.

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

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearDescription()

public AspectType.MetadataTemplate.Annotations.Builder clearDescription()

Optional. Specify a description for a field

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

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearDisplayName()

public AspectType.MetadataTemplate.Annotations.Builder clearDisplayName()

Optional. Specify a displayname for a field.

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

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearDisplayOrder()

public AspectType.MetadataTemplate.Annotations.Builder clearDisplayOrder()

Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AspectType.MetadataTemplate.Annotations.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AspectType.MetadataTemplate.Annotations.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

clearStringType()

public AspectType.MetadataTemplate.Annotations.Builder clearStringType()

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.

string string_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearStringValues()

public AspectType.MetadataTemplate.Annotations.Builder clearStringValues()

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clone()

public AspectType.MetadataTemplate.Annotations.Builder clone()
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

getDefaultInstanceForType()

public AspectType.MetadataTemplate.Annotations getDefaultInstanceForType()
Returns
Type Description
AspectType.MetadataTemplate.Annotations

getDeprecated()

public String getDeprecated()

Optional. Marks a field as deprecated, a deprecation message can be included.

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

Returns
Type Description
String

The deprecated.

getDeprecatedBytes()

public ByteString getDeprecatedBytes()

Optional. Marks a field as deprecated, a deprecation message can be included.

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

Returns
Type Description
ByteString

The bytes for deprecated.

getDescription()

public String getDescription()

Optional. Specify a description for a field

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Specify a description for a field

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

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getDisplayName()

public String getDisplayName()

Optional. Specify a displayname for a field.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Specify a displayname for a field.

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

Returns
Type Description
ByteString

The bytes for displayName.

getDisplayOrder()

public int getDisplayOrder()

Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The displayOrder.

getStringType()

public String getStringType()

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.

string string_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The stringType.

getStringTypeBytes()

public ByteString getStringTypeBytes()

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.

string string_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for stringType.

getStringValues(int index)

public String getStringValues(int index)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The stringValues at the given index.

getStringValuesBytes(int index)

public ByteString getStringValuesBytes(int index)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.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 stringValues at the given index.

getStringValuesCount()

public int getStringValuesCount()

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of stringValues.

getStringValuesList()

public ProtocolStringList getStringValuesList()

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the stringValues.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AspectType.MetadataTemplate.Annotations other)

public AspectType.MetadataTemplate.Annotations.Builder mergeFrom(AspectType.MetadataTemplate.Annotations other)
Parameter
Name Description
other AspectType.MetadataTemplate.Annotations
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public AspectType.MetadataTemplate.Annotations.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Annotations.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

setDeprecated(String value)

public AspectType.MetadataTemplate.Annotations.Builder setDeprecated(String value)

Optional. Marks a field as deprecated, a deprecation message can be included.

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

Parameter
Name Description
value String

The deprecated to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDeprecatedBytes(ByteString value)

public AspectType.MetadataTemplate.Annotations.Builder setDeprecatedBytes(ByteString value)

Optional. Marks a field as deprecated, a deprecation message can be included.

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

Parameter
Name Description
value ByteString

The bytes for deprecated to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDescription(String value)

public AspectType.MetadataTemplate.Annotations.Builder setDescription(String value)

Optional. Specify a description for a field

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public AspectType.MetadataTemplate.Annotations.Builder setDescriptionBytes(ByteString value)

Optional. Specify a description for a field

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDisplayName(String value)

public AspectType.MetadataTemplate.Annotations.Builder setDisplayName(String value)

Optional. Specify a displayname for a field.

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

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AspectType.MetadataTemplate.Annotations.Builder setDisplayNameBytes(ByteString value)

Optional. Specify a displayname for a field.

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

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setDisplayOrder(int value)

public AspectType.MetadataTemplate.Annotations.Builder setDisplayOrder(int value)

Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered

int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The displayOrder to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setStringType(String value)

public AspectType.MetadataTemplate.Annotations.Builder setStringType(String value)

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.

string string_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The stringType to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setStringTypeBytes(ByteString value)

public AspectType.MetadataTemplate.Annotations.Builder setStringTypeBytes(ByteString value)

Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.

string string_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for stringType to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setStringValues(int index, String value)

public AspectType.MetadataTemplate.Annotations.Builder setStringValues(int index, String value)

Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.

repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The stringValues to set.

Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Annotations.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides