Class GlossaryTerm.Builder (0.11.0)

public static final class GlossaryTerm.Builder extends GeneratedMessage.Builder<GlossaryTerm.Builder> implements GlossaryTermOrBuilder

Definition of a term within a specific domain.

Protobuf type google.cloud.geminidataanalytics.v1beta.GlossaryTerm

Static Methods

getDescriptor()

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

Methods

addAllLabels(Iterable<String> values)

public GlossaryTerm.Builder addAllLabels(Iterable<String> values)

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
values Iterable<String>

The labels to add.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

addLabels(String value)

public GlossaryTerm.Builder addLabels(String value)

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
value String

The labels to add.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

addLabelsBytes(ByteString value)

public GlossaryTerm.Builder addLabelsBytes(ByteString value)

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
value ByteString

The bytes of the labels to add.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

build()

public GlossaryTerm build()
Returns
Type Description
GlossaryTerm

buildPartial()

public GlossaryTerm buildPartial()
Returns
Type Description
GlossaryTerm

clear()

public GlossaryTerm.Builder clear()
Returns
Type Description
GlossaryTerm.Builder
Overrides

clearDescription()

public GlossaryTerm.Builder clearDescription()

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
GlossaryTerm.Builder

This builder for chaining.

clearDisplayName()

public GlossaryTerm.Builder clearDisplayName()

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
GlossaryTerm.Builder

This builder for chaining.

clearLabels()

public GlossaryTerm.Builder clearLabels()

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
GlossaryTerm.Builder

This builder for chaining.

getDefaultInstanceForType()

public GlossaryTerm getDefaultInstanceForType()
Returns
Type Description
GlossaryTerm

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the labels.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GlossaryTerm other)

public GlossaryTerm.Builder mergeFrom(GlossaryTerm other)
Parameter
Name Description
other GlossaryTerm
Returns
Type Description
GlossaryTerm.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GlossaryTerm.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GlossaryTerm.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GlossaryTerm.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GlossaryTerm.Builder
Overrides

setDescription(String value)

public GlossaryTerm.Builder setDescription(String value)

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];

Parameter
Name Description
value String

The description to set.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public GlossaryTerm.Builder setDescriptionBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

setDisplayName(String value)

public GlossaryTerm.Builder setDisplayName(String value)

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];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public GlossaryTerm.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.

setLabels(int index, String value)

public GlossaryTerm.Builder setLabels(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The labels to set.

Returns
Type Description
GlossaryTerm.Builder

This builder for chaining.