Package 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("software.amazon.awssdk:codegen") public final class CoreNetwork extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CoreNetwork.Builder,CoreNetwork>

Describes a core network.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CoreNetwork.Builder,CoreNetwork>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.