EndPoint Class

  • java.lang.Object
    • com.azure.resourcemanager.orbital.models.EndPoint

Implements

public final class EndPoint
implements JsonSerializable<EndPoint>

Customer end point to store and retrieve data during a contact with the spacecraft.

Constructor Summary

Constructor Description
EndPoint()

Creates an instance of EndPoint class.

Method Summary

Modifier and Type Method and Description
String endPointName()

Get the endPointName property: Name of an end point.

static EndPoint fromJson(JsonReader jsonReader)

Reads an instance of EndPoint from the JsonReader.

String ipAddress()

Get the ipAddress property: IP Address (IPv4).

String port()

Get the port property: TCP port to listen on to receive data.

Protocol protocol()

Get the protocol property: Protocol either UDP or TCP.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

EndPoint withEndPointName(String endPointName)

Set the endPointName property: Name of an end point.

EndPoint withIpAddress(String ipAddress)

Set the ipAddress property: IP Address (IPv4).

EndPoint withPort(String port)

Set the port property: TCP port to listen on to receive data.

EndPoint withProtocol(Protocol protocol)

Set the protocol property: Protocol either UDP or TCP.

Methods inherited from java.lang.Object

Constructor Details

EndPoint

public EndPoint()

Creates an instance of EndPoint class.

Method Details

endPointName

public String endPointName()

Get the endPointName property: Name of an end point.

Returns:

the endPointName value.

fromJson

public static EndPoint fromJson(JsonReader jsonReader)

Reads an instance of EndPoint from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EndPoint if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

ipAddress

public String ipAddress()

Get the ipAddress property: IP Address (IPv4).

Returns:

the ipAddress value.

port

public String port()

Get the port property: TCP port to listen on to receive data.

Returns:

the port value.

protocol

public Protocol protocol()

Get the protocol property: Protocol either UDP or TCP.

Returns:

the protocol value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withEndPointName

public EndPoint withEndPointName(String endPointName)

Set the endPointName property: Name of an end point.

Parameters:

endPointName - the endPointName value to set.

Returns:

the EndPoint object itself.

withIpAddress

public EndPoint withIpAddress(String ipAddress)

Set the ipAddress property: IP Address (IPv4).

Parameters:

ipAddress - the ipAddress value to set.

Returns:

the EndPoint object itself.

withPort

public EndPoint withPort(String port)

Set the port property: TCP port to listen on to receive data.

Parameters:

port - the port value to set.

Returns:

the EndPoint object itself.

withProtocol

public EndPoint withProtocol(Protocol protocol)

Set the protocol property: Protocol either UDP or TCP.

Parameters:

protocol - the protocol value to set.

Returns:

the EndPoint object itself.

Applies to