Class NetworkMigrationInsight

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

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

An insight produced during a network migration, such as a warning, decision, question, or other context beyond the migrated output.

See Also:
  • Method Details

    • networkMigrationDefinitionID

      public final String networkMigrationDefinitionID()

      The unique identifier of the network migration definition the insight belongs to.

      Returns:
      The unique identifier of the network migration definition the insight belongs to.
    • networkMigrationExecutionID

      public final String networkMigrationExecutionID()

      The unique identifier of the network migration execution the insight belongs to.

      Returns:
      The unique identifier of the network migration execution the insight belongs to.
    • producerID

      public final String producerID()

      The identifier of the job or API request that produced the insight.

      Returns:
      The identifier of the job or API request that produced the insight.
    • producerType

      public final InsightProducerType producerType()

      Whether the insight was produced by a job or by an API request.

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

      Returns:
      Whether the insight was produced by a job or by an API request.
      See Also:
    • producerTypeAsString

      public final String producerTypeAsString()

      Whether the insight was produced by a job or by an API request.

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

      Returns:
      Whether the insight was produced by a job or by an API request.
      See Also:
    • producerName

      public final InsightProducerName producerName()

      The job type or API name that produced the insight.

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

      Returns:
      The job type or API name that produced the insight.
      See Also:
    • producerNameAsString

      public final String producerNameAsString()

      The job type or API name that produced the insight.

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

      Returns:
      The job type or API name that produced the insight.
      See Also:
    • segmentID

      public final String segmentID()

      The unique identifier of the segment the insight relates to; absent for run-level insights.

      Returns:
      The unique identifier of the segment the insight relates to; absent for run-level insights.
    • constructID

      public final String constructID()

      The unique identifier of the construct the insight relates to; absent for run-level and segment-level insights.

      Returns:
      The unique identifier of the construct the insight relates to; absent for run-level and segment-level insights.
    • insightID

      public final String insightID()

      The unique identifier of the insight.

      Returns:
      The unique identifier of the insight.
    • insightLevel

      public final InsightLevel insightLevel()

      The level that the insight applies to: the run, a segment, or a construct.

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

      Returns:
      The level that the insight applies to: the run, a segment, or a construct.
      See Also:
    • insightLevelAsString

      public final String insightLevelAsString()

      The level that the insight applies to: the run, a segment, or a construct.

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

      Returns:
      The level that the insight applies to: the run, a segment, or a construct.
      See Also:
    • insightType

      public final InsightType insightType()

      The type of the insight.

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

      Returns:
      The type of the insight.
      See Also:
    • insightTypeAsString

      public final String insightTypeAsString()

      The type of the insight.

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

      Returns:
      The type of the insight.
      See Also:
    • insightMessage

      public final InsightMessage insightMessage()

      The content of the insight.

      Returns:
      The content of the insight.
    • createdAt

      public final Instant createdAt()

      The timestamp when the insight was created.

      Returns:
      The timestamp when the insight was created.
    • toBuilder

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

      public static NetworkMigrationInsight.Builder builder()
    • serializableBuilderClass

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