Package software.amazon.awssdk.services.datazone.model

Class ConnectionSummary

java.lang.Object

software.amazon.awssdk.services.datazone.model.ConnectionSummary

All Implemented Interfaces:

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

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

The summary of a connection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConnectionSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ConnectionSummary.Builder	builder()
String	connectionId()	The ID of a connection.
String	domainId()	The domain ID of a connection.
String	domainUnitId()	The domain unit ID of a connection.
String	environmentId()	The environment ID of a connection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPhysicalEndpoints()	For responses, this returns true if the service returned a value for the PhysicalEndpoints property.
String	name()	The connection name.
List<PhysicalEndpoint>	physicalEndpoints()	The connection physical endpoints.
String	projectId()	The connection project ID.
ConnectionPropertiesOutput	props()	The connection props.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ConnectionSummary.Builder>	serializableBuilderClass()
ConnectionSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ConnectionType	type()	The connection type.
String	typeAsString()	The connection type.

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

connectionId

public final String connectionId()

The ID of a connection.

Returns:

The ID of a connection.

domainId

public final String domainId()

The domain ID of a connection.

Returns:

The domain ID of a connection.

domainUnitId

public final String domainUnitId()

The domain unit ID of a connection.

Returns:

The domain unit ID of a connection.

environmentId

public final String environmentId()

The environment ID of a connection.

Returns:

The environment ID of a connection.

name

public final String name()

The connection name.

Returns:

The connection name.

hasPhysicalEndpoints

public final boolean hasPhysicalEndpoints()

For responses, this returns true if the service returned a value for the PhysicalEndpoints 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.

physicalEndpoints

public final List<PhysicalEndpoint> physicalEndpoints()

The connection physical endpoints.

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 hasPhysicalEndpoints() method.

Returns:

The connection physical endpoints.

projectId

public final String projectId()

The connection project ID.

Returns:

The connection project ID.

props

public final ConnectionPropertiesOutput props()

The connection props.

Returns:

The connection props.

type

public final ConnectionType type()

The connection type.

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

Returns:

The connection type.

See Also:

ConnectionType

typeAsString

public final String typeAsString()

The connection type.

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

Returns:

The connection type.

See Also:

ConnectionType

toBuilder

public ConnectionSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ConnectionSummary.Builder,ConnectionSummary>

builder

public static ConnectionSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ConnectionSummary.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo