Class NetworkResource

java.lang.Object
software.amazon.awssdk.services.privatenetworks.model.NetworkResource
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NetworkResource.Builder,NetworkResource>
@Generated("software.amazon.awssdk:codegen") public final class NetworkResource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NetworkResource.Builder,NetworkResource>

Information about a network resource.

See Also:

  • Method Details

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributes

      public final List<NameValuePair> attributes()

      The attributes of the network resource.

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

      Returns:
      The attributes of the network resource.

    • commitmentInformation

      public final CommitmentInformation commitmentInformation()

      Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

      Returns:
      Information about the commitment period for the radio unit. Shows the duration, the date and time that the contract started and ends, and the renewal status of the commitment period.

    • createdAt

      public final Instant createdAt()

      The creation time of the network resource.

      Returns:
      The creation time of the network resource.

    • description

      public final String description()

      The description of the network resource.

      Returns:
      The description of the network resource.

    • health

      public final HealthStatus health()

      The health of the network resource.

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

      Returns:
      The health of the network resource.
      See Also:

    • healthAsString

      public final String healthAsString()

      The health of the network resource.

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

      Returns:
      The health of the network resource.
      See Also:

    • model

      public final String model()

      The model of the network resource.

      Returns:
      The model of the network resource.

    • networkArn

      public final String networkArn()

      The Amazon Resource Name (ARN) of the network on which this network resource appears.

      Returns:
      The Amazon Resource Name (ARN) of the network on which this network resource appears.

    • networkResourceArn

      public final String networkResourceArn()

      The Amazon Resource Name (ARN) of the network resource.

      Returns:
      The Amazon Resource Name (ARN) of the network resource.

    • networkSiteArn

      public final String networkSiteArn()

      The Amazon Resource Name (ARN) of the network site on which this network resource appears.

      Returns:
      The Amazon Resource Name (ARN) of the network site on which this network resource appears.

    • orderArn

      public final String orderArn()

      The Amazon Resource Name (ARN) of the order used to purchase this network resource.

      Returns:
      The Amazon Resource Name (ARN) of the order used to purchase this network resource.

    • position

      public final Position position()

      The position of the network resource.

      Returns:
      The position of the network resource.

    • returnInformation

      public final ReturnInformation returnInformation()

      Information about a request to return the network resource.

      Returns:
      Information about a request to return the network resource.

    • serialNumber

      public final String serialNumber()

      The serial number of the network resource.

      Returns:
      The serial number of the network resource.

    • status

      public final NetworkResourceStatus status()

      The status of the network resource.

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

      Returns:
      The status of the network resource.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the network resource.

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

      Returns:
      The status of the network resource.
      See Also:

    • statusReason

      public final String statusReason()

      The status reason of the network resource.

      Returns:
      The status reason of the network resource.

    • type

      public final NetworkResourceType type()

      The type of the network resource.

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

      Returns:
      The type of the network resource.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the network resource.

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

      Returns:
      The type of the network resource.
      See Also:

    • vendor

      public final String vendor()

      The vendor of the network resource.

      Returns:
      The vendor of the network resource.

    • toBuilder

      public NetworkResource.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<NetworkResource.Builder,NetworkResource>
      Returns:
      a builder for type T

    • builder

      public static NetworkResource.Builder builder()

    • serializableBuilderClass

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