Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class GeneralServiceEndpoint

java.lang.Object

com.hedera.hashgraph.sdk.RegisteredServiceEndpoint

com.hedera.hashgraph.sdk.RegisteredServiceEndpointBase<GeneralServiceEndpoint>

com.hedera.hashgraph.sdk.GeneralServiceEndpoint

public class GeneralServiceEndpoint
extends RegisteredServiceEndpointBase<GeneralServiceEndpoint>

Represents a general-purpose service endpoint.

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.RegisteredServiceEndpoint

domainName, ipAddress, port, requiresTls

Constructor Summary

Constructors

Constructor	Description
GeneralServiceEndpoint()	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) static GeneralServiceEndpoint	fromJson(com.google.gson.JsonObject json)	Parses GeneralServiceEndpoint from the type-specific JSON object the MirrorNode.
(package private) static GeneralServiceEndpoint	fromProtobuf(RegisteredServiceEndpoint serviceEndpoint)
String	getDescription()	Returns the description of the service provided by this endpoint.
GeneralServiceEndpoint	setDescription(String description)	Sets a short description of the service provided.
(package private) RegisteredServiceEndpoint	toProtobuf()	Build the protobuf.
String	toString()

Methods inherited from class com.hedera.hashgraph.sdk.RegisteredServiceEndpointBase

setDomainName, setIpAddress, setPort, setRequiresTls

Methods inherited from class com.hedera.hashgraph.sdk.RegisteredServiceEndpoint

getDomainName, getIpAddress, getPort, isRequiresTls, toStringHelper, validateNoIpAndDomain

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GeneralServiceEndpoint

public GeneralServiceEndpoint()

Constructor.

Method Details

getDescription

@Nullable
public String getDescription()

Returns the description of the service provided by this endpoint.

Returns:

the service description, or null if not set

setDescription

public GeneralServiceEndpoint setDescription(String description)

Sets a short description of the service provided. This value MUST NOT exceed 100 bytes when encoded as UTF-8.

Parameters:

description - a short description of the service

Returns:

this

fromProtobuf

static GeneralServiceEndpoint fromProtobuf(RegisteredServiceEndpoint serviceEndpoint)

fromJson

static GeneralServiceEndpoint fromJson(com.google.gson.JsonObject json)

Parses GeneralServiceEndpoint from the type-specific JSON object the MirrorNode.

Parameters:

json - the json containing general service specific data

Returns:

this

toProtobuf

RegisteredServiceEndpoint toProtobuf()

Description copied from class: RegisteredServiceEndpoint

Build the protobuf.

Specified by:

toProtobuf in class RegisteredServiceEndpoint

Returns:

the protobuf representation

toString

public String toString()

Overrides:

toString in class Object