Class GroupConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GroupConfiguration.Builder
builder()
final List
<GroupConfigurationItem> The configuration currently associated with the group and in effect.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
If present, the reason why a request to update the group configuration failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Configuration property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProposedConfiguration property.final List
<GroupConfigurationItem> If present, the new configuration that is in the process of being applied to the group.static Class
<? extends GroupConfiguration.Builder> final GroupConfigurationStatus
status()
The current status of an attempt to update the group configuration.final String
The current status of an attempt to update the group configuration.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 theisEmpty()
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
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 theisEmpty()
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
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
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 returnGroupConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of an attempt to update the group configuration.
- See Also:
-
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 returnGroupConfigurationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of an attempt to update the group configuration.
- See Also:
-
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
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 interfaceToCopyableBuilder<GroupConfiguration.Builder,
GroupConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-