Class AspectType.MetadataTemplate.Annotations (1.44.0)

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

Definition of the annotations of a field

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AspectType.MetadataTemplate.Annotations

Static Fields

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_ORDER_FIELD_NUMBER

public static final int DISPLAY_ORDER_FIELD_NUMBER
Field Value
Type Description
int

STRING_TYPE_FIELD_NUMBER

public static final int STRING_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STRING_VALUES_FIELD_NUMBER

public static final int STRING_VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AspectType.MetadataTemplate.Annotations getDefaultInstance()
Returns
Type Description
AspectType.MetadataTemplate.Annotations

getDescriptor()

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

newBuilder()

public static AspectType.MetadataTemplate.Annotations.Builder newBuilder()
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

newBuilder(AspectType.MetadataTemplate.Annotations prototype)

public static AspectType.MetadataTemplate.Annotations.Builder newBuilder(AspectType.MetadataTemplate.Annotations prototype)
Parameter
Name Description
prototype AspectType.MetadataTemplate.Annotations
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

parseDelimitedFrom(InputStream input)

public static AspectType.MetadataTemplate.Annotations parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AspectType.MetadataTemplate.Annotations parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AspectType.MetadataTemplate.Annotations parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AspectType.MetadataTemplate.Annotations parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AspectType.MetadataTemplate.Annotations parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AspectType.MetadataTemplate.Annotations parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AspectType.MetadataTemplate.Annotations parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AspectType.MetadataTemplate.Annotations
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AspectType.MetadataTemplate.Annotations> parser()
Returns
Type Description
Parser<Annotations>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

getParserForType()

public Parser<AspectType.MetadataTemplate.Annotations> getParserForType()
Returns
Type Description
Parser<Annotations>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AspectType.MetadataTemplate.Annotations.Builder newBuilderForType()
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AspectType.MetadataTemplate.Annotations.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AspectType.MetadataTemplate.Annotations.Builder toBuilder()
Returns
Type Description
AspectType.MetadataTemplate.Annotations.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException