Class Card.CardHeader.Builder (2.45.1)

public static final class Card.CardHeader.Builder extends GeneratedMessageV3.Builder<Card.CardHeader.Builder> implements Card.CardHeaderOrBuilder

Represents a card header. For an example in Google Chat apps, see Add a header.

Google Workspace Add-ons and Chat apps:

Protobuf type google.apps.card.v1.Card.CardHeader

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Card.CardHeader.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Card.CardHeader.Builder
Overrides

build()

public Card.CardHeader build()
Returns
Type Description
Card.CardHeader

buildPartial()

public Card.CardHeader buildPartial()
Returns
Type Description
Card.CardHeader

clear()

public Card.CardHeader.Builder clear()
Returns
Type Description
Card.CardHeader.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Card.CardHeader.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Card.CardHeader.Builder
Overrides

clearImageAltText()

public Card.CardHeader.Builder clearImageAltText()

The alternative text of this image that's used for accessibility.

string image_alt_text = 5;

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

clearImageType()

public Card.CardHeader.Builder clearImageType()

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

clearImageUrl()

public Card.CardHeader.Builder clearImageUrl()

The HTTPS URL of the image in the card header.

string image_url = 4;

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Card.CardHeader.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Card.CardHeader.Builder
Overrides

clearSubtitle()

public Card.CardHeader.Builder clearSubtitle()

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

clearTitle()

public Card.CardHeader.Builder clearTitle()

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

clone()

public Card.CardHeader.Builder clone()
Returns
Type Description
Card.CardHeader.Builder
Overrides

getDefaultInstanceForType()

public Card.CardHeader getDefaultInstanceForType()
Returns
Type Description
Card.CardHeader

getDescriptorForType()

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

getImageAltText()

public String getImageAltText()

The alternative text of this image that's used for accessibility.

string image_alt_text = 5;

Returns
Type Description
String

The imageAltText.

getImageAltTextBytes()

public ByteString getImageAltTextBytes()

The alternative text of this image that's used for accessibility.

string image_alt_text = 5;

Returns
Type Description
ByteString

The bytes for imageAltText.

getImageType()

public Widget.ImageType getImageType()

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Returns
Type Description
Widget.ImageType

The imageType.

getImageTypeValue()

public int getImageTypeValue()

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for imageType.

getImageUrl()

public String getImageUrl()

The HTTPS URL of the image in the card header.

string image_url = 4;

Returns
Type Description
String

The imageUrl.

getImageUrlBytes()

public ByteString getImageUrlBytes()

The HTTPS URL of the image in the card header.

string image_url = 4;

Returns
Type Description
ByteString

The bytes for imageUrl.

getSubtitle()

public String getSubtitle()

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Returns
Type Description
String

The subtitle.

getSubtitleBytes()

public ByteString getSubtitleBytes()

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Returns
Type Description
ByteString

The bytes for subtitle.

getTitle()

public String getTitle()

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Returns
Type Description
ByteString

The bytes for title.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Card.CardHeader other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Card.CardHeader.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Card.CardHeader.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Card.CardHeader.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Card.CardHeader.Builder
Overrides

setImageAltText(String value)

public Card.CardHeader.Builder setImageAltText(String value)

The alternative text of this image that's used for accessibility.

string image_alt_text = 5;

Parameter
Name Description
value String

The imageAltText to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setImageAltTextBytes(ByteString value)

public Card.CardHeader.Builder setImageAltTextBytes(ByteString value)

The alternative text of this image that's used for accessibility.

string image_alt_text = 5;

Parameter
Name Description
value ByteString

The bytes for imageAltText to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setImageType(Widget.ImageType value)

public Card.CardHeader.Builder setImageType(Widget.ImageType value)

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Parameter
Name Description
value Widget.ImageType

The imageType to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setImageTypeValue(int value)

public Card.CardHeader.Builder setImageTypeValue(int value)

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

.google.apps.card.v1.Widget.ImageType image_type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for imageType to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setImageUrl(String value)

public Card.CardHeader.Builder setImageUrl(String value)

The HTTPS URL of the image in the card header.

string image_url = 4;

Parameter
Name Description
value String

The imageUrl to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setImageUrlBytes(ByteString value)

public Card.CardHeader.Builder setImageUrlBytes(ByteString value)

The HTTPS URL of the image in the card header.

string image_url = 4;

Parameter
Name Description
value ByteString

The bytes for imageUrl to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Card.CardHeader.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Card.CardHeader.Builder
Overrides

setSubtitle(String value)

public Card.CardHeader.Builder setSubtitle(String value)

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Parameter
Name Description
value String

The subtitle to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setSubtitleBytes(ByteString value)

public Card.CardHeader.Builder setSubtitleBytes(ByteString value)

The subtitle of the card header. If specified, appears on its own line below the title.

string subtitle = 2;

Parameter
Name Description
value ByteString

The bytes for subtitle to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setTitle(String value)

public Card.CardHeader.Builder setTitle(String value)

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Parameter
Name Description
value String

The title to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setTitleBytes(ByteString value)

public Card.CardHeader.Builder setTitleBytes(ByteString value)

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

string title = 1;

Parameter
Name Description
value ByteString

The bytes for title to set.

Returns
Type Description
Card.CardHeader.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Card.CardHeader.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Card.CardHeader.Builder
Overrides