Class Section

java.lang.Object
software.amazon.awssdk.services.apiportal.model.Section
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Section.Builder,Section>

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

A named group of API pages in the portal navigation.

See Also:
  • Method Details

    • sectionName

      public final String sectionName()

      Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).

      Returns:
      Shown in the portal navigation. Same bound as page titles and operation names, and no control characters (the service rejects a blank name).
    • hasProductApiPageArns

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

      public final List<String> productApiPageArns()
      Returns the value of the ProductApiPageArns property for this object.

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

      Returns:
      The value of the ProductApiPageArns property for this object.
    • toBuilder

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

      public static Section.Builder builder()
    • serializableBuilderClass

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