software.amazon.awssdk.services.groundstation.model

Class EndpointDetails

java.lang.Object

software.amazon.awssdk.services.groundstation.model.EndpointDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>

@Generated(value="software.amazon.awssdk:codegen")
public final class EndpointDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>

Information about the endpoint details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointDetails.Builder

Method Summary

Modifier and Type	Method and Description
AwsGroundStationAgentEndpoint	awsGroundStationAgentEndpoint() An agent endpoint.
static EndpointDetails.Builder	builder()
DataflowEndpoint	endpoint() A dataflow endpoint.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHealthReasons() For responses, this returns true if the service returned a value for the HealthReasons property.
List<CapabilityHealthReason>	healthReasons() Health reasons for a dataflow endpoint.
List<String>	healthReasonsAsStrings() Health reasons for a dataflow endpoint.
CapabilityHealth	healthStatus() A dataflow endpoint health status.
String	healthStatusAsString() A dataflow endpoint health status.
List<SdkField<?>>	sdkFields()
SecurityDetails	securityDetails() Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
static Class<? extends EndpointDetails.Builder>	serializableBuilderClass()
EndpointDetails.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

awsGroundStationAgentEndpoint

public final AwsGroundStationAgentEndpoint awsGroundStationAgentEndpoint()

An agent endpoint.

Returns:

An agent endpoint.

endpoint

public final DataflowEndpoint endpoint()

A dataflow endpoint.

Returns:

A dataflow endpoint.

healthReasons

public final List<CapabilityHealthReason> healthReasons()

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHealthReasons() method.

Returns:

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

hasHealthReasons

public final boolean hasHealthReasons()

For responses, this returns true if the service returned a value for the HealthReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

healthReasonsAsStrings

public final List<String> healthReasonsAsStrings()

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHealthReasons() method.

Returns:

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

healthStatus

public final CapabilityHealth healthStatus()

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

If the service returns an enum value that is not available in the current SDK version, healthStatus will return CapabilityHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

Returns:

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

See Also:

CapabilityHealth

healthStatusAsString

public final String healthStatusAsString()

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

If the service returns an enum value that is not available in the current SDK version, healthStatus will return CapabilityHealth.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from healthStatusAsString().

Returns:

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

See Also:

CapabilityHealth

securityDetails

public final SecurityDetails securityDetails()

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

Returns:

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

toBuilder

public EndpointDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointDetails.Builder,EndpointDetails>

builder

public static EndpointDetails.Builder builder()

serializableBuilderClass

public static Class<? extends EndpointDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo