Class Grid

  • All Implemented Interfaces:
    GridOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class Grid
    extends com.google.protobuf.GeneratedMessageV3
    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:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Grid.Builder
      Displays a grid with a collection of items.
      static class  Grid.GridItem
      Represents an item in a grid layout.
      static interface  Grid.GridItemOrBuilder  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.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 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.
      java.util.List<Grid.GridItem> getItemsList()
      The items to display in the grid.
      Grid.GridItemOrBuilder getItemsOrBuilder​(int index)
      The items to display in the grid.
      java.util.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()  
      java.lang.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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Grid.Builder newBuilder()  
      static Grid.Builder newBuilder​(Grid prototype)  
      Grid.Builder newBuilderForType()  
      protected Grid.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Grid parseDelimitedFrom​(java.io.InputStream input)  
      static Grid parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static Grid parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Grid parseFrom​(java.nio.ByteBuffer data)  
      static Grid parseFrom​(java.nio.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.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, 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
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getTitle

        public java.lang.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 java.util.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
      • 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
      • 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.
      • 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.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Grid parseFrom​(java.nio.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​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static Grid parseFrom​(java.io.InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Grid parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static Grid parseDelimitedFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static Grid parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public Grid.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder