Package software.amazon.awssdk.services.resourcegroups.model

Class GroupConfiguration

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

A service configuration associated with a resource group. The configuration options are determined by the Amazon Web Services service that defines the Type, and specifies which resources can be included in the group. You can add a service configuration when you create the group by using CreateGroup, or later by using the PutGroupConfiguration operation. For details about group service configuration syntax, see Service configurations for resource groups.

See Also:

  • Method Details

    • hasConfiguration

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

    • configuration

      public final List<GroupConfigurationItem> configuration()

      The configuration currently associated with the group and in effect.

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

      Returns:
      The configuration currently associated with the group and in effect.

    • hasProposedConfiguration

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

    • proposedConfiguration

      public final List<GroupConfigurationItem> proposedConfiguration()

      If present, the new configuration that is in the process of being applied to the group.

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

      Returns:
      If present, the new configuration that is in the process of being applied to the group.

    • status

      public final GroupConfigurationStatus status()

      The current status of an attempt to update the group configuration.

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

      Returns:
      The current status of an attempt to update the group configuration.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of an attempt to update the group configuration.

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

      Returns:
      The current status of an attempt to update the group configuration.
      See Also:

    • failureReason

      public final String failureReason()

      If present, the reason why a request to update the group configuration failed.

      Returns:
      If present, the reason why a request to update the group configuration failed.

    • toBuilder

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

    • builder

      public static GroupConfiguration.Builder builder()

    • serializableBuilderClass

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