software.amazon.awssdk.services.networkmanager.model

Class CoreNetwork

java.lang.Object

software.amazon.awssdk.services.networkmanager.model.CoreNetwork

All Implemented Interfaces:

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

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

Describes a core network.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CoreNetwork.Builder

Method Summary

Modifier and Type	Method and Description
static CoreNetwork.Builder	builder()
String	coreNetworkArn() The ARN of a core network.
String	coreNetworkId() The ID of a core network.
Instant	createdAt() The timestamp when a core network was created.
String	description() The description of a core network.
List<CoreNetworkEdge>	edges() The edges within a core network.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	globalNetworkId() The ID of the global network that your core network is a part of.
boolean	hasEdges() For responses, this returns true if the service returned a value for the Edges property.
int	hashCode()
boolean	hasSegments() For responses, this returns true if the service returned a value for the Segments property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
List<CoreNetworkSegment>	segments() The segments within a core network.
static Class<? extends CoreNetwork.Builder>	serializableBuilderClass()
CoreNetworkState	state() The current state of a core network.
String	stateAsString() The current state of a core network.
List<Tag>	tags() The list of key-value tags associated with a core network.
CoreNetwork.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

globalNetworkId

public final String globalNetworkId()

The ID of the global network that your core network is a part of.

Returns:

The ID of the global network that your core network is a part of.

coreNetworkId

public final String coreNetworkId()

The ID of a core network.

Returns:

The ID of a core network.

coreNetworkArn

public final String coreNetworkArn()

The ARN of a core network.

Returns:

The ARN of a core network.

description

public final String description()

The description of a core network.

Returns:

The description of a core network.

createdAt

public final Instant createdAt()

The timestamp when a core network was created.

Returns:

The timestamp when a core network was created.

state

public final CoreNetworkState state()

The current state of a core network.

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

Returns:

The current state of a core network.

See Also:

CoreNetworkState

stateAsString

public final String stateAsString()

The current state of a core network.

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

Returns:

The current state of a core network.

See Also:

CoreNetworkState

hasSegments

public final boolean hasSegments()

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

segments

public final List<CoreNetworkSegment> segments()

The segments within a core network.

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

Returns:

The segments within a core network.

hasEdges

public final boolean hasEdges()

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

edges

public final List<CoreNetworkEdge> edges()

The edges within a core network.

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

Returns:

The edges within a core network.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

The list of key-value tags associated with a core network.

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

Returns:

The list of key-value tags associated with a core network.

toBuilder

public CoreNetwork.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CoreNetwork.Builder,CoreNetwork>

builder

public static CoreNetwork.Builder builder()

serializableBuilderClass

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