Class AspectType.MetadataTemplate.Annotations.Builder (1.38.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
TypeDescription
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
NameDescription
valuesIterable<String>

The stringValues to add.

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

The stringValues to add.

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

The bytes of the stringValues to add.

Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

build()

public AspectType.MetadataTemplate.Annotations build()
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations

buildPartial()

public AspectType.MetadataTemplate.Annotations buildPartial()
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations

clear()

public AspectType.MetadataTemplate.Annotations.Builder clear()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AspectType.MetadataTemplate.Annotations.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AspectType.MetadataTemplate.Annotations.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

clone()

public AspectType.MetadataTemplate.Annotations.Builder clone()
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder
Overrides

getDefaultInstanceForType()

public AspectType.MetadataTemplate.Annotations getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Specify a description for a field

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

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. Specify a displayname for a field.

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Specify a displayname for a field.

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

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

The index of the element to return.

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

The index of the value to return.

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

A list containing the stringValues.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AspectType.MetadataTemplate.Annotations other)

public AspectType.MetadataTemplate.Annotations.Builder mergeFrom(AspectType.MetadataTemplate.Annotations other)
Parameter
NameDescription
otherAspectType.MetadataTemplate.Annotations
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public AspectType.MetadataTemplate.Annotations.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Annotations.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueString

The deprecated to set.

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

The bytes for deprecated to set.

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

The description to set.

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

The bytes for description to set.

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

The displayName to set.

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

The bytes for displayName to set.

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

The displayOrder to set.

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

The stringType to set.

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

The bytes for stringType to set.

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

The index to set the value at.

valueString

The stringValues to set.

Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AspectType.MetadataTemplate.Annotations.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AspectType.MetadataTemplate.Annotations.Builder
Overrides