Class Availability (0.59.0)

public final class Availability extends GeneratedMessage implements AvailabilityOrBuilder

Represents a user's current availability information in Google Chat, including their state (for example, Active, Away, Do Not Disturb) and any custom status.

Protobuf type google.chat.v1.Availability

Static Fields

CUSTOM_STATUS_FIELD_NUMBER

public static final int CUSTOM_STATUS_FIELD_NUMBER
Field Value
Type Description
int

DO_NOT_DISTURB_METADATA_FIELD_NUMBER

public static final int DO_NOT_DISTURB_METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Availability getDefaultInstance()
Returns
Type Description
Availability

getDescriptor()

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

newBuilder()

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

newBuilder(Availability prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCustomStatus()

public CustomStatus getCustomStatus()

Optional. The user's custom status.

.google.chat.v1.CustomStatus custom_status = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomStatus

The customStatus.

getCustomStatusOrBuilder()

public CustomStatusOrBuilder getCustomStatusOrBuilder()

Optional. The user's custom status.

.google.chat.v1.CustomStatus custom_status = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomStatusOrBuilder

getDefaultInstanceForType()

public Availability getDefaultInstanceForType()
Returns
Type Description
Availability

getDoNotDisturbMetadata()

public DoNotDisturbMetadata getDoNotDisturbMetadata()

Output only. Metadata if the user state is set to DO_NOT_DISTURB.

.google.chat.v1.DoNotDisturbMetadata do_not_disturb_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DoNotDisturbMetadata

The doNotDisturbMetadata.

getDoNotDisturbMetadataOrBuilder()

public DoNotDisturbMetadataOrBuilder getDoNotDisturbMetadataOrBuilder()

Output only. Metadata if the user state is set to DO_NOT_DISTURB.

.google.chat.v1.DoNotDisturbMetadata do_not_disturb_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DoNotDisturbMetadataOrBuilder

getName()

public String getName()

Identifier. Resource name of the user's availability.

Format: users/{user}/availability

{user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Resource name of the user's availability.

Format: users/{user}/availability

{user} is the id for the Person in the People API or Admin SDK directory API. For example, users/123456789.

The user's email address or me can also be used as an alias to refer to the caller. For example, users/user@example.com or users/me.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Availability.State getState()

Output only. The user's current availability state.

.google.chat.v1.Availability.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Availability.State

The state.

getStateMetadataCase()

public Availability.StateMetadataCase getStateMetadataCase()
Returns
Type Description
Availability.StateMetadataCase

getStateValue()

public int getStateValue()

Output only. The user's current availability state.

.google.chat.v1.Availability.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasCustomStatus()

public boolean hasCustomStatus()

Optional. The user's custom status.

.google.chat.v1.CustomStatus custom_status = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the customStatus field is set.

hasDoNotDisturbMetadata()

public boolean hasDoNotDisturbMetadata()

Output only. Metadata if the user state is set to DO_NOT_DISTURB.

.google.chat.v1.DoNotDisturbMetadata do_not_disturb_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the doNotDisturbMetadata field is set.

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 Availability.Builder newBuilderForType()
Returns
Type Description
Availability.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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