Class Image (2.37.1)

public final class Image extends GeneratedMessageV3 implements ImageOrBuilder

An image that is specified by a URL and can have an onClick action. For an example, see Image.

Google Workspace Add-ons and Chat apps:

Protobuf type google.apps.card.v1.Image

Implements

ImageOrBuilder

Static Fields

ALT_TEXT_FIELD_NUMBER

public static final int ALT_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_URL_FIELD_NUMBER

public static final int IMAGE_URL_FIELD_NUMBER
Field Value
TypeDescription
int

ON_CLICK_FIELD_NUMBER

public static final int ON_CLICK_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Image getDefaultInstance()
Returns
TypeDescription
Image

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Image.Builder newBuilder()
Returns
TypeDescription
Image.Builder

newBuilder(Image prototype)

public static Image.Builder newBuilder(Image prototype)
Parameter
NameDescription
prototypeImage
Returns
TypeDescription
Image.Builder

parseDelimitedFrom(InputStream input)

public static Image parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Image parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Image parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Image parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Image parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Image parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Image
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Image> parser()
Returns
TypeDescription
Parser<Image>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAltText()

public String getAltText()

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

string alt_text = 3;

Returns
TypeDescription
String

The altText.

getAltTextBytes()

public ByteString getAltTextBytes()

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

string alt_text = 3;

Returns
TypeDescription
ByteString

The bytes for altText.

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
TypeDescription
Image

getImageUrl()

public String getImageUrl()

The HTTPS URL that hosts the image.

For example:

<code><code> https://developers.google.com/chat/images/quickstart-app-avatar.png </code></code>

string image_url = 1;

Returns
TypeDescription
String

The imageUrl.

getImageUrlBytes()

public ByteString getImageUrlBytes()

The HTTPS URL that hosts the image.

For example:

<code><code> https://developers.google.com/chat/images/quickstart-app-avatar.png </code></code>

string image_url = 1;

Returns
TypeDescription
ByteString

The bytes for imageUrl.

getOnClick()

public OnClick getOnClick()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
TypeDescription
OnClick

The onClick.

getOnClickOrBuilder()

public OnClickOrBuilder getOnClickOrBuilder()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
TypeDescription
OnClickOrBuilder

getParserForType()

public Parser<Image> getParserForType()
Returns
TypeDescription
Parser<Image>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasOnClick()

public boolean hasOnClick()

When a user clicks the image, the click triggers this action.

.google.apps.card.v1.OnClick on_click = 2;

Returns
TypeDescription
boolean

Whether the onClick field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Image.Builder newBuilderForType()
Returns
TypeDescription
Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Image.Builder toBuilder()
Returns
TypeDescription
Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException