Class StartDataSourceIntrospectionResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDataSourceIntrospectionResponse.Builder,StartDataSourceIntrospectionResponse>

@Generated("software.amazon.awssdk:codegen") public final class StartDataSourceIntrospectionResponse extends AppSyncResponse implements ToCopyableBuilder<StartDataSourceIntrospectionResponse.Builder,StartDataSourceIntrospectionResponse>
  • Method Details

    • introspectionId

      public final String introspectionId()

      The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.

      Returns:
      The introspection ID. Each introspection contains a unique ID that can be used to reference the instrospection record.
    • introspectionStatus

      public final DataSourceIntrospectionStatus introspectionStatus()

      The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

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

      Returns:
      The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.
      See Also:
    • introspectionStatusAsString

      public final String introspectionStatusAsString()

      The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.

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

      Returns:
      The status of the introspection during creation. By default, when a new instrospection has been created, the status will be set to PROCESSING. Once the operation has been completed, the status will change to SUCCESS or FAILED depending on how the data was parsed. A FAILED operation will return an error and its details as an introspectionStatusDetail.
      See Also:
    • introspectionStatusDetail

      public final String introspectionStatusDetail()

      The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.

      Returns:
      The error detail field. When a FAILED introspectionStatus is returned, the introspectionStatusDetail will also return the exact error that was generated during the operation.
    • 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<StartDataSourceIntrospectionResponse.Builder,StartDataSourceIntrospectionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends StartDataSourceIntrospectionResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.