Class AgentSpace

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

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

Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.

See Also:
  • Method Details

    • name

      public final String name()

      The name of the AgentSpace.

      Returns:
      The name of the AgentSpace.
    • description

      public final String description()

      The description of the AgentSpace.

      Returns:
      The description of the AgentSpace.
    • locale

      public final String locale()

      The locale for the AgentSpace, which determines the language used in agent responses.

      Returns:
      The locale for the AgentSpace, which determines the language used in agent responses.
    • createdAt

      public final Instant createdAt()

      The timestamp when the resource was created.

      Returns:
      The timestamp when the resource was created.
    • updatedAt

      public final Instant updatedAt()

      The timestamp when the resource was last updated.

      Returns:
      The timestamp when the resource was last updated.
    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.

      Returns:
      The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
    • agentSpaceId

      public final String agentSpaceId()

      The unique identifier of the AgentSpace

      Returns:
      The unique identifier of the AgentSpace
    • preferences

      public final Map<AgentSpacePreferenceKey,Boolean> preferences()

      The preferences configured on the agent space. Preferences that are not set take their default values.

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

      Returns:
      The preferences configured on the agent space. Preferences that are not set take their default values.
    • hasPreferences

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

      public final Map<String,Boolean> preferencesAsStrings()

      The preferences configured on the agent space. Preferences that are not set take their default values.

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

      Returns:
      The preferences configured on the agent space. Preferences that are not set take their default values.
    • toBuilder

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

      public static AgentSpace.Builder builder()
    • serializableBuilderClass

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