Interface GlossaryTermOrBuilder (0.9.0)

Version latest

• 0.9.0 (latest)
• 0.8.0
• 0.6.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface GlossaryTermOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

Required. The description or meaning of the term. For example: "Click-through rate", "The percentage of users who complete a desired action", "An order that is waiting to be processed."

string description = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Required. The description or meaning of the term. For example: "Click-through rate", "The percentage of users who complete a desired action", "An order that is waiting to be processed."

string description = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Required. User friendly display name of the glossary term being defined. For example: "CTR", "conversion rate", "pending"

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. User friendly display name of the glossary term being defined. For example: "CTR", "conversion rate", "pending"

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getLabels(int index)

public abstract String getLabels(int index)

Optional. A list of general purpose labels associated to this term. For example: ["click rate", "clickthrough", "waiting"]

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

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The labels at the given index.

getLabelsBytes(int index)

public abstract ByteString getLabelsBytes(int index)

Optional. A list of general purpose labels associated to this term. For example: ["click rate", "clickthrough", "waiting"]

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

getLabelsCount()

public abstract int getLabelsCount()

Optional. A list of general purpose labels associated to this term. For example: ["click rate", "clickthrough", "waiting"]

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

Returns
Type	Description
int	The count of labels.

getLabelsList()

public abstract List<String> getLabelsList()

Optional. A list of general purpose labels associated to this term. For example: ["click rate", "clickthrough", "waiting"]

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

Returns
Type	Description
List<String>	A list containing the labels.