Class Section (0.55.0)

public final class Section extends GeneratedMessage implements SectionOrBuilder

Represents a section in Google Chat. Sections help users organize their spaces. There are two types of sections:

  1. System Sections: These are predefined sections managed by Google Chat. Their resource names are fixed, and they cannot be created, deleted, or have their display_name modified. Examples include:
  2. users/{user}/sections/default-direct-messages
  3. users/{user}/sections/default-spaces
  4. users/{user}/sections/default-apps

  5. Custom Sections: These are sections created and managed by the user. Creating a custom section using CreateSection requires a display_name. Custom sections can be updated using UpdateSection and deleted using DeleteSection.

Protobuf type google.chat.v1.Section

Implements

SectionOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SORT_ORDER_FIELD_NUMBER

public static final int SORT_ORDER_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Section getDefaultInstance()
Returns
Type Description
Section

getDescriptor()

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

newBuilder()

public static Section.Builder newBuilder()
Returns
Type Description
Section.Builder

newBuilder(Section prototype)

public static Section.Builder newBuilder(Section prototype)
Parameter
Name Description
prototype Section
Returns
Type Description
Section.Builder

parseDelimitedFrom(InputStream input)

public static Section parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Section parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Section parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Section parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Section parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Section parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Section parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Section parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Section parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Section parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Section parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Section parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Section
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Section> parser()
Returns
Type Description
Parser<Section>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Section getDefaultInstanceForType()
Returns
Type Description
Section

getDisplayName()

public String getDisplayName()

Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION. Supports up to 80 characters. Required when creating a CUSTOM_SECTION.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The section's display name. Only populated for sections of type CUSTOM_SECTION. Supports up to 80 characters. Required when creating a CUSTOM_SECTION.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. Resource name of the section.

For system sections, the section ID is a constant string:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

    Format: users/{user}/sections/{section}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of the section.

For system sections, the section ID is a constant string:

  • DEFAULT_DIRECT_MESSAGES: users/{user}/sections/default-direct-messages
  • DEFAULT_SPACES: users/{user}/sections/default-spaces
  • DEFAULT_APPS: users/{user}/sections/default-apps

    Format: users/{user}/sections/{section}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Section> getParserForType()
Returns
Type Description
Parser<Section>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSortOrder()

public int getSortOrder()

Output only. The order of the section in relation to other sections. Sections with a lower sort_order value appear before sections with a higher value.

int32 sort_order = 3;

Returns
Type Description
int

The sortOrder.

getType()

public Section.SectionType getType()

Required. The type of the section.

.google.chat.v1.Section.SectionType type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Section.SectionType

The type.

getTypeValue()

public int getTypeValue()

Required. The type of the section.

.google.chat.v1.Section.SectionType type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Section.Builder newBuilderForType()
Returns
Type Description
Section.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Section.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Section.Builder
Overrides

toBuilder()

public Section.Builder toBuilder()
Returns
Type Description
Section.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException