Class Site

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

Information about a site.

See Also:

  • Method Details

    • siteId

      public final String siteId()
      Returns the value of the SiteId property for this object.
      Returns:
      The value of the SiteId property for this object.

    • accountId

      public final String accountId()
      Returns the value of the AccountId property for this object.
      Returns:
      The value of the AccountId property for this object.

    • name

      public final String name()
      Returns the value of the Name property for this object.
      Returns:
      The value of the Name property for this object.

    • description

      public final String description()
      Returns the value of the Description property for this object.
      Returns:
      The value of the Description property for this object.

    • 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 Map<String,String> tags()

      The site tags.

      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 site tags.

    • siteArn

      public final String siteArn()
      Returns the value of the SiteArn property for this object.
      Returns:
      The value of the SiteArn property for this object.

    • notes

      public final String notes()

      Notes about a site.

      Returns:
      Notes about a site.

    • operatingAddressCountryCode

      public final String operatingAddressCountryCode()

      The ISO-3166 two-letter country code where the hardware is installed and powered on.

      Returns:
      The ISO-3166 two-letter country code where the hardware is installed and powered on.

    • operatingAddressStateOrRegion

      public final String operatingAddressStateOrRegion()

      State or region where the hardware is installed and powered on.

      Returns:
      State or region where the hardware is installed and powered on.

    • operatingAddressCity

      public final String operatingAddressCity()

      City where the hardware is installed and powered on.

      Returns:
      City where the hardware is installed and powered on.

    • rackPhysicalProperties

      public final RackPhysicalProperties rackPhysicalProperties()

      Information about the physical and logistical details for a rack at the site.

      Returns:
      Information about the physical and logistical details for a rack at the site.

    • toBuilder

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

    • builder

      public static Site.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.