Package mxaccess_gateway.v1

Class MxaccessGateway.AcknowledgeAlarmByNameCommand

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

mxaccess_gateway.v1.MxaccessGateway.AcknowledgeAlarmByNameCommand

All Implemented Interfaces:

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

Enclosing class:

MxaccessGateway

public static final class MxaccessGateway.AcknowledgeAlarmByNameCommand
extends com.google.protobuf.GeneratedMessage
implements MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

 Acknowledge a single alarm by its (name, provider, group) tuple. Used
 when the public RPC's AlarmFullReference (Provider!Group.Tag) cannot
 be resolved to a GUID directly. The worker invokes
 wwAlarmConsumerClass.AlarmAckByName which reaches the same alarm
 history path as AlarmAckByGUID.
 

Protobuf type mxaccess_gateway.v1.AcknowledgeAlarmByNameCommand

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder	Acknowledge a single alarm by its (name, provider, group) tuple.

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	ALARM_NAME_FIELD_NUMBER
static final int	COMMENT_FIELD_NUMBER
static final int	GROUP_NAME_FIELD_NUMBER
static final int	OPERATOR_DOMAIN_FIELD_NUMBER
static final int	OPERATOR_FULL_NAME_FIELD_NUMBER
static final int	OPERATOR_NODE_FIELD_NUMBER
static final int	OPERATOR_USER_FIELD_NUMBER
static final int	PROVIDER_NAME_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)
String	getAlarmName()	Tag/alarm name (e.g.
com.google.protobuf.ByteString	getAlarmNameBytes()	Tag/alarm name (e.g.
String	getComment()	string comment = 4;
com.google.protobuf.ByteString	getCommentBytes()	string comment = 4;
static MxaccessGateway.AcknowledgeAlarmByNameCommand	getDefaultInstance()
MxaccessGateway.AcknowledgeAlarmByNameCommand	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getGroupName()	Area/group name (e.g.
com.google.protobuf.ByteString	getGroupNameBytes()	Area/group name (e.g.
String	getOperatorDomain()	string operator_domain = 7;
com.google.protobuf.ByteString	getOperatorDomainBytes()	string operator_domain = 7;
String	getOperatorFullName()	string operator_full_name = 8;
com.google.protobuf.ByteString	getOperatorFullNameBytes()	string operator_full_name = 8;
String	getOperatorNode()	string operator_node = 6;
com.google.protobuf.ByteString	getOperatorNodeBytes()	string operator_node = 6;
String	getOperatorUser()	string operator_user = 5;
com.google.protobuf.ByteString	getOperatorUserBytes()	string operator_user = 5;
com.google.protobuf.Parser<MxaccessGateway.AcknowledgeAlarmByNameCommand>	getParserForType()
String	getProviderName()	AVEVA alarm-provider name (literal "Galaxy" for ArchestrA Galaxies).
com.google.protobuf.ByteString	getProviderNameBytes()	AVEVA alarm-provider name (literal "Galaxy" for ArchestrA Galaxies).
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder	newBuilder()
static MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder	newBuilder(MxaccessGateway.AcknowledgeAlarmByNameCommand prototype)
MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder	newBuilderForType()
protected MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseDelimitedFrom(InputStream input)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(byte[] data)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(com.google.protobuf.ByteString data)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(com.google.protobuf.CodedInputStream input)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(InputStream input)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(ByteBuffer data)
static MxaccessGateway.AcknowledgeAlarmByNameCommand	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MxaccessGateway.AcknowledgeAlarmByNameCommand>	parser()
MxaccessGateway.AcknowledgeAlarmByNameCommand.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

ALARM_NAME_FIELD_NUMBER

public static final int ALARM_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

PROVIDER_NAME_FIELD_NUMBER

public static final int PROVIDER_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

GROUP_NAME_FIELD_NUMBER

public static final int GROUP_NAME_FIELD_NUMBER

See Also:

• Constant Field Values

COMMENT_FIELD_NUMBER

public static final int COMMENT_FIELD_NUMBER

See Also:

• Constant Field Values

OPERATOR_USER_FIELD_NUMBER

public static final int OPERATOR_USER_FIELD_NUMBER

See Also:

• Constant Field Values

OPERATOR_NODE_FIELD_NUMBER

public static final int OPERATOR_NODE_FIELD_NUMBER

See Also:

• Constant Field Values

OPERATOR_DOMAIN_FIELD_NUMBER

public static final int OPERATOR_DOMAIN_FIELD_NUMBER

See Also:

• Constant Field Values

OPERATOR_FULL_NAME_FIELD_NUMBER

public static final int OPERATOR_FULL_NAME_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

getAlarmName

public String getAlarmName()

 Tag/alarm name (e.g. "TestMachine_001.TestAlarm001"). Tag itself
 may contain dots; the gateway-side parser splits on the first dot
 after the '!' separator.
 

string alarm_name = 1;

Specified by:

getAlarmName in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The alarmName.

getAlarmNameBytes

public com.google.protobuf.ByteString getAlarmNameBytes()

 Tag/alarm name (e.g. "TestMachine_001.TestAlarm001"). Tag itself
 may contain dots; the gateway-side parser splits on the first dot
 after the '!' separator.
 

string alarm_name = 1;

Specified by:

getAlarmNameBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for alarmName.

getProviderName

public String getProviderName()

 AVEVA alarm-provider name (literal "Galaxy" for ArchestrA Galaxies).
 

string provider_name = 2;

Specified by:

getProviderName in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The providerName.

getProviderNameBytes

public com.google.protobuf.ByteString getProviderNameBytes()

 AVEVA alarm-provider name (literal "Galaxy" for ArchestrA Galaxies).
 

string provider_name = 2;

Specified by:

getProviderNameBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for providerName.

getGroupName

public String getGroupName()

 Area/group name (e.g. "TestArea").
 

string group_name = 3;

Specified by:

getGroupName in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The groupName.

getGroupNameBytes

public com.google.protobuf.ByteString getGroupNameBytes()

 Area/group name (e.g. "TestArea").
 

string group_name = 3;

Specified by:

getGroupNameBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for groupName.

getComment

public String getComment()

string comment = 4;

Specified by:

getComment in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The comment.

getCommentBytes

public com.google.protobuf.ByteString getCommentBytes()

string comment = 4;

Specified by:

getCommentBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for comment.

getOperatorUser

public String getOperatorUser()

string operator_user = 5;

Specified by:

getOperatorUser in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The operatorUser.

getOperatorUserBytes

public com.google.protobuf.ByteString getOperatorUserBytes()

string operator_user = 5;

Specified by:

getOperatorUserBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for operatorUser.

getOperatorNode

public String getOperatorNode()

string operator_node = 6;

Specified by:

getOperatorNode in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The operatorNode.

getOperatorNodeBytes

public com.google.protobuf.ByteString getOperatorNodeBytes()

string operator_node = 6;

Specified by:

getOperatorNodeBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for operatorNode.

getOperatorDomain

public String getOperatorDomain()

string operator_domain = 7;

Specified by:

getOperatorDomain in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The operatorDomain.

getOperatorDomainBytes

public com.google.protobuf.ByteString getOperatorDomainBytes()

string operator_domain = 7;

Specified by:

getOperatorDomainBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for operatorDomain.

getOperatorFullName

public String getOperatorFullName()

string operator_full_name = 8;

Specified by:

getOperatorFullName in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The operatorFullName.

getOperatorFullNameBytes

public com.google.protobuf.ByteString getOperatorFullNameBytes()

string operator_full_name = 8;

Specified by:

getOperatorFullNameBytes in interface MxaccessGateway.AcknowledgeAlarmByNameCommandOrBuilder

Returns:

The bytes for operatorFullName.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MxaccessGateway.AcknowledgeAlarmByNameCommand 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.AcknowledgeAlarmByNameCommand parseFrom(byte[] data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder newBuilder()

newBuilder

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

toBuilder

public MxaccessGateway.AcknowledgeAlarmByNameCommand.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static MxaccessGateway.AcknowledgeAlarmByNameCommand getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder