Interface AspectType.MetadataTemplate.AnnotationsOrBuilder (1.42.0) 

public static interface AspectType.MetadataTemplate.AnnotationsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDeprecated()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the stringValues.