- 1.76.0 (latest)
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.71.0
 - 1.70.0
 - 1.68.0
 - 1.66.0
 - 1.65.0
 - 1.62.0
 - 1.61.0
 - 1.60.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.49.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.44.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.37.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.32.0
 - 1.31.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.25.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.16.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.9.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 - 1.3.0
 - 1.2.0
 - 1.1.2
 - 1.0.1
 - 0.2.2
 
public static final class AspectType.MetadataTemplate.Annotations.Builder extends GeneratedMessageV3.Builder<AspectType.MetadataTemplate.Annotations.Builder> implements AspectType.MetadataTemplate.AnnotationsOrBuilderDefinition of the annotations of a field.
 Protobuf type google.cloud.dataplex.v1.AspectType.MetadataTemplate.Annotations
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AspectType.MetadataTemplate.Annotations.BuilderStatic 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. You can use them to suggest values to users through console.
 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 | 
        |
addStringValues(String value)
public AspectType.MetadataTemplate.Annotations.Builder addStringValues(String value)Optional. Suggested hints for string fields. You can use them to suggest values to users through console.
 repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe 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. You can use them to suggest values to users through console.
 repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe 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 | 
        |
clearDeprecated()
public AspectType.MetadataTemplate.Annotations.Builder clearDeprecated()Optional. Marks a field as deprecated. You can include a deprecation message.
 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. 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. Display name 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. Display order for a field. You can use this 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 | 
        |
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 | 
        |
clearStringType()
public AspectType.MetadataTemplate.Annotations.Builder clearStringType()Optional. You can use String Type annotations 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. You can use them to suggest values to users through console.
 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 | 
        |
getDefaultInstanceForType()
public AspectType.MetadataTemplate.Annotations getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
AspectType.MetadataTemplate.Annotations | 
        |
getDeprecated()
public String getDeprecated()Optional. Marks a field as deprecated. You can include a deprecation message.
 string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The deprecated.  | 
      
getDeprecatedBytes()
public ByteString getDeprecatedBytes()Optional. Marks a field as deprecated. You can include a deprecation message.
 string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for deprecated.  | 
      
getDescription()
public String getDescription()Optional. Description for a field.
 string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The description.  | 
      
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. 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 | 
        |
getDisplayName()
public String getDisplayName()Optional. Display name for a field.
 string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The displayName.  | 
      
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Optional. Display name 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. Display order for a field. You can use this 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. You can use String Type annotations 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. You can use String Type annotations 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. You can use them to suggest values to users through console.
 repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
index | 
        intThe 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. You can use them to suggest values to users through console.
 repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
index | 
        intThe 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. You can use them to suggest values to users through console.
 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. You can use them to suggest values to users through console.
 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 | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
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 | 
        |
| 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 | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AspectType.MetadataTemplate.Annotations.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
AspectType.MetadataTemplate.Annotations.Builder | 
        |
setDeprecated(String value)
public AspectType.MetadataTemplate.Annotations.Builder setDeprecated(String value)Optional. Marks a field as deprecated. You can include a deprecation message.
 string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe 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. You can include a deprecation message.
 string deprecated = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe 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. Description for a field.
 string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe 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. Description for a field.
 string description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe 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. Display name for a field.
 string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe 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. Display name for a field.
 string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe 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. Display order for a field. You can use this to reorder where a field is rendered.
 int32 display_order = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description | 
value | 
        intThe 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 | 
        |
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 | 
        |
setStringType(String value)
public AspectType.MetadataTemplate.Annotations.Builder setStringType(String value)Optional. You can use String Type annotations 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 | 
        StringThe 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. You can use String Type annotations 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 | 
        ByteStringThe 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. You can use them to suggest values to users through console.
 repeated string string_values = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description | 
index | 
        intThe index to set the value at.  | 
      
value | 
        StringThe 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 | 
        |