Package mxaccess_gateway.v1

Class MxaccessGateway.SubscribeAlarmsCommand

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

mxaccess_gateway.v1.MxaccessGateway.SubscribeAlarmsCommand

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Enclosing class:

MxaccessGateway

public static final class MxaccessGateway.SubscribeAlarmsCommand
extends com.google.protobuf.GeneratedMessage
implements MxaccessGateway.SubscribeAlarmsCommandOrBuilder

 Subscribe the worker's alarm consumer to an AVEVA alarm provider.
 Subscription expression follows the canonical
 `\\<machine>\Galaxy!<area>` format (literal "Galaxy" provider). The
 worker spins up a wnwrapConsumer-backed subscription on its STA on
 first call; subsequent calls are an error (use UnsubscribeAlarms then
 SubscribeAlarms to reconfigure).
 

Protobuf type mxaccess_gateway.v1.SubscribeAlarmsCommand

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MxaccessGateway.SubscribeAlarmsCommand.Builder	Subscribe the worker's alarm consumer to an AVEVA alarm provider.

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>, 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	FAILOVER_FIELD_NUMBER
static final int	FORCED_MODE_FIELD_NUMBER
static final int	SUBSCRIPTION_EXPRESSION_FIELD_NUMBER
static final int	WATCH_LIST_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)
static MxaccessGateway.SubscribeAlarmsCommand	getDefaultInstance()
MxaccessGateway.SubscribeAlarmsCommand	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
MxaccessGateway.AlarmFailoverConfig	getFailover()	.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;
MxaccessGateway.AlarmFailoverConfigOrBuilder	getFailoverOrBuilder()	.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;
MxaccessGateway.AlarmProviderMode	getForcedMode()	UNSPECIFIED = auto-failover/failback.
int	getForcedModeValue()	UNSPECIFIED = auto-failover/failback.
com.google.protobuf.Parser<MxaccessGateway.SubscribeAlarmsCommand>	getParserForType()
int	getSerializedSize()
String	getSubscriptionExpression()	string subscription_expression = 1;
com.google.protobuf.ByteString	getSubscriptionExpressionBytes()	string subscription_expression = 1;
MxaccessGateway.AlarmSubtagTarget	getWatchList(int index)	Subtag watch-list resolved by the gateway (GR SQL + config).
int	getWatchListCount()	Subtag watch-list resolved by the gateway (GR SQL + config).
List<MxaccessGateway.AlarmSubtagTarget>	getWatchListList()	Subtag watch-list resolved by the gateway (GR SQL + config).
MxaccessGateway.AlarmSubtagTargetOrBuilder	getWatchListOrBuilder(int index)	Subtag watch-list resolved by the gateway (GR SQL + config).
List<? extends MxaccessGateway.AlarmSubtagTargetOrBuilder>	getWatchListOrBuilderList()	Subtag watch-list resolved by the gateway (GR SQL + config).
boolean	hasFailover()	.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static MxaccessGateway.SubscribeAlarmsCommand.Builder	newBuilder()
static MxaccessGateway.SubscribeAlarmsCommand.Builder	newBuilder(MxaccessGateway.SubscribeAlarmsCommand prototype)
MxaccessGateway.SubscribeAlarmsCommand.Builder	newBuilderForType()
protected MxaccessGateway.SubscribeAlarmsCommand.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static MxaccessGateway.SubscribeAlarmsCommand	parseDelimitedFrom(InputStream input)
static MxaccessGateway.SubscribeAlarmsCommand	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(byte[] data)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(com.google.protobuf.ByteString data)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(com.google.protobuf.CodedInputStream input)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(InputStream input)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(ByteBuffer data)
static MxaccessGateway.SubscribeAlarmsCommand	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MxaccessGateway.SubscribeAlarmsCommand>	parser()
MxaccessGateway.SubscribeAlarmsCommand.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

SUBSCRIPTION_EXPRESSION_FIELD_NUMBER

public static final int SUBSCRIPTION_EXPRESSION_FIELD_NUMBER

See Also:

• Constant Field Values

FORCED_MODE_FIELD_NUMBER

public static final int FORCED_MODE_FIELD_NUMBER

See Also:

• Constant Field Values

WATCH_LIST_FIELD_NUMBER

public static final int WATCH_LIST_FIELD_NUMBER

See Also:

• Constant Field Values

FAILOVER_FIELD_NUMBER

public static final int FAILOVER_FIELD_NUMBER

See Also:

• Constant Field Values

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

getSubscriptionExpression

public String getSubscriptionExpression()

string subscription_expression = 1;

Specified by:

getSubscriptionExpression in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

The subscriptionExpression.

getSubscriptionExpressionBytes

public com.google.protobuf.ByteString getSubscriptionExpressionBytes()

string subscription_expression = 1;

Specified by:

getSubscriptionExpressionBytes in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

The bytes for subscriptionExpression.

getForcedModeValue

public int getForcedModeValue()

 UNSPECIFIED = auto-failover/failback. ALARMMGR/SUBTAG force one provider.
 

.mxaccess_gateway.v1.AlarmProviderMode forced_mode = 2;

Specified by:

getForcedModeValue in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

The enum numeric value on the wire for forcedMode.

getForcedMode

public MxaccessGateway.AlarmProviderMode getForcedMode()

 UNSPECIFIED = auto-failover/failback. ALARMMGR/SUBTAG force one provider.
 

.mxaccess_gateway.v1.AlarmProviderMode forced_mode = 2;

Specified by:

getForcedMode in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

The forcedMode.

getWatchListList

public List<MxaccessGateway.AlarmSubtagTarget> getWatchListList()

 Subtag watch-list resolved by the gateway (GR SQL + config). Empty in pure
 alarmmgr mode; in subtag mode it bounds what the consumer can observe.
 

repeated .mxaccess_gateway.v1.AlarmSubtagTarget watch_list = 3;

Specified by:

getWatchListList in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

getWatchListOrBuilderList

public List<? extends MxaccessGateway.AlarmSubtagTargetOrBuilder> getWatchListOrBuilderList()

 Subtag watch-list resolved by the gateway (GR SQL + config). Empty in pure
 alarmmgr mode; in subtag mode it bounds what the consumer can observe.
 

repeated .mxaccess_gateway.v1.AlarmSubtagTarget watch_list = 3;

Specified by:

getWatchListOrBuilderList in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

getWatchListCount

public int getWatchListCount()

 Subtag watch-list resolved by the gateway (GR SQL + config). Empty in pure
 alarmmgr mode; in subtag mode it bounds what the consumer can observe.
 

repeated .mxaccess_gateway.v1.AlarmSubtagTarget watch_list = 3;

Specified by:

getWatchListCount in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

getWatchList

public MxaccessGateway.AlarmSubtagTarget getWatchList(int index)

 Subtag watch-list resolved by the gateway (GR SQL + config). Empty in pure
 alarmmgr mode; in subtag mode it bounds what the consumer can observe.
 

repeated .mxaccess_gateway.v1.AlarmSubtagTarget watch_list = 3;

Specified by:

getWatchList in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

getWatchListOrBuilder

public MxaccessGateway.AlarmSubtagTargetOrBuilder getWatchListOrBuilder(int index)

 Subtag watch-list resolved by the gateway (GR SQL + config). Empty in pure
 alarmmgr mode; in subtag mode it bounds what the consumer can observe.
 

repeated .mxaccess_gateway.v1.AlarmSubtagTarget watch_list = 3;

Specified by:

getWatchListOrBuilder in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

hasFailover

public boolean hasFailover()

.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;

Specified by:

hasFailover in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

Whether the failover field is set.

getFailover

public MxaccessGateway.AlarmFailoverConfig getFailover()

.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;

Specified by:

getFailover in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

Returns:

The failover.

getFailoverOrBuilder

public MxaccessGateway.AlarmFailoverConfigOrBuilder getFailoverOrBuilder()

.mxaccess_gateway.v1.AlarmFailoverConfig failover = 4;

Specified by:

getFailoverOrBuilder in interface MxaccessGateway.SubscribeAlarmsCommandOrBuilder

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 MxaccessGateway.SubscribeAlarmsCommand parseFrom(ByteBuffer data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(com.google.protobuf.ByteString data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(byte[] data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                 throws IOException

Throws:

IOException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(com.google.protobuf.CodedInputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

public static MxaccessGateway.SubscribeAlarmsCommand parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

newBuilderForType

public MxaccessGateway.SubscribeAlarmsCommand.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MxaccessGateway.SubscribeAlarmsCommand.Builder newBuilder()

newBuilder

public static MxaccessGateway.SubscribeAlarmsCommand.Builder newBuilder(MxaccessGateway.SubscribeAlarmsCommand prototype)

toBuilder

public MxaccessGateway.SubscribeAlarmsCommand.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected MxaccessGateway.SubscribeAlarmsCommand.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static MxaccessGateway.SubscribeAlarmsCommand getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<MxaccessGateway.SubscribeAlarmsCommand> 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 MxaccessGateway.SubscribeAlarmsCommand getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder