Class Instance

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

The details of the instance.

See Also:

  • Method Details

    • instanceId

      public final String instanceId()

      The Amazon Web Services Supply Chain instance identifier.

      Returns:
      The Amazon Web Services Supply Chain instance identifier.

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID that owns the instance.

      Returns:
      The Amazon Web Services account ID that owns the instance.

    • state

      public final InstanceState state()

      The state of the instance.

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

      Returns:
      The state of the instance.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the instance.

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

      Returns:
      The state of the instance.
      See Also:

    • errorMessage

      public final String errorMessage()

      The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

      Returns:
      The Amazon Web Services Supply Chain instance error message. If the instance results in an unhealthy state, customers need to check the error message, delete the current instance, and recreate a new one based on the mitigation from the error message.

    • webAppDnsDomain

      public final String webAppDnsDomain()

      The WebApp DNS domain name of the instance.

      Returns:
      The WebApp DNS domain name of the instance.

    • createdTime

      public final Instant createdTime()

      The instance creation timestamp.

      Returns:
      The instance creation timestamp.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The instance last modified timestamp.

      Returns:
      The instance last modified timestamp.

    • instanceName

      public final String instanceName()

      The Amazon Web Services Supply Chain instance name.

      Returns:
      The Amazon Web Services Supply Chain instance name.

    • instanceDescription

      public final String instanceDescription()

      The Amazon Web Services Supply Chain instance description.

      Returns:
      The Amazon Web Services Supply Chain instance description.

    • kmsKeyArn

      public final String kmsKeyArn()

      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

      Returns:
      The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you optionally provided for encryption. If you did not provide anything here, AWS Supply Chain uses the Amazon Web Services owned KMS key and nothing is returned.

    • versionNumber

      public final Double versionNumber()

      The version number of the instance.

      Returns:
      The version number of the instance.

    • toBuilder

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

    • builder

      public static Instance.Builder builder()

    • serializableBuilderClass

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