Class ContextStore

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

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

Describes a context store.

See Also:
  • Method Details

    • globalNetworkId

      public final String globalNetworkId()

      The ID of the global network that the context store belongs to.

      Returns:
      The ID of the global network that the context store belongs to.
    • contextStoreId

      public final String contextStoreId()

      The ID of the context store.

      Returns:
      The ID of the context store.
    • contextStoreArn

      public final String contextStoreArn()

      The Amazon Resource Name (ARN) of the context store.

      Returns:
      The Amazon Resource Name (ARN) of the context store.
    • description

      public final String description()

      The description of the context store.

      Returns:
      The description of the context store.
    • createdAt

      public final Instant createdAt()

      The date and time that the context store was created.

      Returns:
      The date and time that the context store was created.
    • state

      public final ContextStoreState state()

      The state of the context store. The possible values are the following:

      • PENDING: The context store is being created.

      • AVAILABLE: The context store is ready to use.

      • UPDATING: The context store is being updated.

      • DELETING: The context store is being deleted.

      • DELETED: The context store is deleted.

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

      Returns:
      The state of the context store. The possible values are the following:

      • PENDING: The context store is being created.

      • AVAILABLE: The context store is ready to use.

      • UPDATING: The context store is being updated.

      • DELETING: The context store is being deleted.

      • DELETED: The context store is deleted.

      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the context store. The possible values are the following:

      • PENDING: The context store is being created.

      • AVAILABLE: The context store is ready to use.

      • UPDATING: The context store is being updated.

      • DELETING: The context store is being deleted.

      • DELETED: The context store is deleted.

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

      Returns:
      The state of the context store. The possible values are the following:

      • PENDING: The context store is being created.

      • AVAILABLE: The context store is ready to use.

      • UPDATING: The context store is being updated.

      • DELETING: The context store is being deleted.

      • DELETED: The context store is deleted.

      See Also:
    • 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 List<Tag> tags()

      The tags associated with the context store.

      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 tags associated with the context store.
    • toBuilder

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

      public static ContextStore.Builder builder()
    • serializableBuilderClass

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