Package com.google.apps.card.v1

Class Grid

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.apps.card.v1.Grid
All Implemented Interfaces:
GridOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Grid extends com.google.protobuf.GeneratedMessage implements GridOrBuilder
 Displays a grid with a collection of items. Items can only include text or
 images. For responsive columns, or to include more than text or images, use
 [`Columns`][google.apps.card.v1.Columns]. For an example in Google Chat apps,
 see [Display a Grid with a collection of
 items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items).

 A grid supports any number of columns and items. The number of rows is
 determined by items divided by columns. A grid with
 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns
 has 6 rows.

 [Google Workspace add-ons and Chat
 apps](https://developers.google.com/workspace/extend):

 For example, the following JSON creates a 2 column grid with a single
 item:

 ```
 "grid": {
 "title": "A fine collection of items",
 "columnCount": 2,
 "borderStyle": {
 "type": "STROKE",
 "cornerRadius": 4
 },
 "items": [
 {
 "image": {
 "imageUri": "https://www.example.com/image.png",
 "cropStyle": {
 "type": "SQUARE"
 },
 "borderStyle": {
 "type": "STROKE"
 }
 },
 "title": "An item",
 "textAlignment": "CENTER"
 }
 ],
 "onClick": {
 "openLink": {
 "url": "https://www.example.com"
 }
 }
 }
 ```
Protobuf type google.apps.card.v1.Grid
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Grid.Builder
    Displays a grid with a collection of items.
    static final class 
    Grid.GridItem
    Represents an item in a grid layout.
    static interface 
    Grid.GridItemOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BORDER_STYLE_FIELD_NUMBER
     
    static final int
    COLUMN_COUNT_FIELD_NUMBER
     
    static final int
    ITEMS_FIELD_NUMBER
     
    static final int
    ON_CLICK_FIELD_NUMBER
     
    static final int
    TITLE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    BorderStyle
    getBorderStyle()
    The border style to apply to each grid item.
    BorderStyleOrBuilder
    getBorderStyleOrBuilder()
    The border style to apply to each grid item.
    int
    getColumnCount()
    The number of columns to display in the grid.
    static Grid
    getDefaultInstance()
     
    Grid
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Grid.GridItem
    getItems(int index)
    The items to display in the grid.
    int
    getItemsCount()
    The items to display in the grid.
    List<Grid.GridItem>
    getItemsList()
    The items to display in the grid.
    Grid.GridItemOrBuilder
    getItemsOrBuilder(int index)
    The items to display in the grid.
    List<? extends Grid.GridItemOrBuilder>
    getItemsOrBuilderList()
    The items to display in the grid.
    OnClick
    getOnClick()
    This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
    OnClickOrBuilder
    getOnClickOrBuilder()
    This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
    com.google.protobuf.Parser<Grid>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTitle()
    The text that displays in the grid header.
    com.google.protobuf.ByteString
    getTitleBytes()
    The text that displays in the grid header.
    boolean
    hasBorderStyle()
    The border style to apply to each grid item.
    int
    hashCode()
     
    boolean
    hasOnClick()
    This callback is reused by each individual grid item, but with the item's identifier and index in the items list added to the callback's parameters.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Grid.Builder
    newBuilder()
     
    static Grid.Builder
    newBuilder(Grid prototype)
     
    Grid.Builder
    newBuilderForType()
     
    protected Grid.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Grid
    parseDelimitedFrom(InputStream input)
     
    static Grid
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Grid
    parseFrom(byte[] data)
     
    static Grid
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Grid
    parseFrom(com.google.protobuf.ByteString data)
     
    static Grid
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Grid
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Grid
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Grid
    parseFrom(InputStream input)
     
    static Grid
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Grid
    parseFrom(ByteBuffer data)
     
    static Grid
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Grid>
    parser()
     
    Grid.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTitle

      public String getTitle()
       The text that displays in the grid header.
      string title = 1;
      Specified by:
      getTitle in interface GridOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       The text that displays in the grid header.
      string title = 1;
      Specified by:
      getTitleBytes in interface GridOrBuilder
      Returns:
      The bytes for title.

    • getItemsList

      public List<Grid.GridItem> getItemsList()
       The items to display in the grid.
      repeated .google.apps.card.v1.Grid.GridItem items = 2;
      Specified by:
      getItemsList in interface GridOrBuilder

    • getItemsOrBuilderList

      public List<? extends Grid.GridItemOrBuilder> getItemsOrBuilderList()
       The items to display in the grid.
      repeated .google.apps.card.v1.Grid.GridItem items = 2;
      Specified by:
      getItemsOrBuilderList in interface GridOrBuilder

    • getItemsCount

      public int getItemsCount()
       The items to display in the grid.
      repeated .google.apps.card.v1.Grid.GridItem items = 2;
      Specified by:
      getItemsCount in interface GridOrBuilder

    • getItems

      public Grid.GridItem getItems(int index)
       The items to display in the grid.
      repeated .google.apps.card.v1.Grid.GridItem items = 2;
      Specified by:
      getItems in interface GridOrBuilder

    • getItemsOrBuilder

      public Grid.GridItemOrBuilder getItemsOrBuilder(int index)
       The items to display in the grid.
      repeated .google.apps.card.v1.Grid.GridItem items = 2;
      Specified by:
      getItemsOrBuilder in interface GridOrBuilder

    • hasBorderStyle

      public boolean hasBorderStyle()
       The border style to apply to each grid item.
      .google.apps.card.v1.BorderStyle border_style = 3;
      Specified by:
      hasBorderStyle in interface GridOrBuilder
      Returns:
      Whether the borderStyle field is set.

    • getBorderStyle

      public BorderStyle getBorderStyle()
       The border style to apply to each grid item.
      .google.apps.card.v1.BorderStyle border_style = 3;
      Specified by:
      getBorderStyle in interface GridOrBuilder
      Returns:
      The borderStyle.

    • getBorderStyleOrBuilder

      public BorderStyleOrBuilder getBorderStyleOrBuilder()
       The border style to apply to each grid item.
      .google.apps.card.v1.BorderStyle border_style = 3;
      Specified by:
      getBorderStyleOrBuilder in interface GridOrBuilder

    • getColumnCount

      public int getColumnCount()
       The number of columns to display in the grid. A default value
 is used if this field isn't specified, and that default value is
 different depending on where the grid is shown (dialog versus companion).
      int32 column_count = 4;
      Specified by:
      getColumnCount in interface GridOrBuilder
      Returns:
      The columnCount.

    • hasOnClick

      public boolean hasOnClick()
       This callback is reused by each individual grid item, but with the
 item's identifier and index in the items list added to the callback's
 parameters.
      .google.apps.card.v1.OnClick on_click = 5;
      Specified by:
      hasOnClick in interface GridOrBuilder
      Returns:
      Whether the onClick field is set.

    • getOnClick

      public OnClick getOnClick()
       This callback is reused by each individual grid item, but with the
 item's identifier and index in the items list added to the callback's
 parameters.
      .google.apps.card.v1.OnClick on_click = 5;
      Specified by:
      getOnClick in interface GridOrBuilder
      Returns:
      The onClick.

    • getOnClickOrBuilder

      public OnClickOrBuilder getOnClickOrBuilder()
       This callback is reused by each individual grid item, but with the
 item's identifier and index in the items list added to the callback's
 parameters.
      .google.apps.card.v1.OnClick on_click = 5;
      Specified by:
      getOnClickOrBuilder in interface GridOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Grid parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Grid parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Grid parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Grid parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Grid parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Grid parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Grid parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Grid.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Grid.Builder newBuilder()

    • newBuilder

      public static Grid.Builder newBuilder(Grid prototype)

    • toBuilder

      public Grid.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Grid.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Grid getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Grid> parser()

    • getParserForType

      public com.google.protobuf.Parser<Grid> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Grid getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder