Package com.inductiveautomation.ignition.gateway.gan

Record Class IncomingConnectionResource

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.gan.IncomingConnectionResource

Record Components:

connectionId - The remote connection ID

securityStatus - The security status of the connection

public record IncomingConnectionResource(String connectionId, IncomingConnectionResource.SecurityStatus securityStatus)
extends Record

A resource that holds settings for an incoming Gateway Network connection. Notably, this is a named resource which did not have a name in the previous PersistentRecord implementation, so the resource name is the system name of the remote gateway.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IncomingConnectionResource.SecurityStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCOMING_CONNECTIONS
static final ResourceTypeMeta<IncomingConnectionResource>	META
static final ResourceType	RESOURCE_TYPE

Constructor Summary

Constructors

Constructor	Description
IncomingConnectionResource(String connectionId, IncomingConnectionResource.SecurityStatus securityStatus)	Creates an instance of a IncomingConnectionResource record class.

Method Summary

Modifier and Type	Method	Description
String	connectionId()	Returns the value of the connectionId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
com.inductiveautomation.metro.api.RemoteSystemId	getConnectionId()
final int	hashCode()	Returns a hash code value for this object.
IncomingConnectionResource.SecurityStatus	securityStatus()	Returns the value of the securityStatus record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INCOMING_CONNECTIONS

public static final String INCOMING_CONNECTIONS

See Also:

• Constant Field Values

RESOURCE_TYPE

public static final ResourceType RESOURCE_TYPE

META

public static final ResourceTypeMeta<IncomingConnectionResource> META

Constructor Details

IncomingConnectionResource

public IncomingConnectionResource(String connectionId,
 IncomingConnectionResource.SecurityStatus securityStatus)

Creates an instance of a IncomingConnectionResource record class.

Parameters:

connectionId - the value for the connectionId record component

securityStatus - the value for the securityStatus record component

Method Details

getConnectionId

public com.inductiveautomation.metro.api.RemoteSystemId getConnectionId()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

connectionId

public String connectionId()

Returns the value of the connectionId record component.

Returns:

the value of the connectionId record component

securityStatus

public IncomingConnectionResource.SecurityStatus securityStatus()

Returns the value of the securityStatus record component.

Returns:

the value of the securityStatus record component