Class GetDataProductResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.datazone.model.DataZoneResponse
software.amazon.awssdk.services.datazone.model.GetDataProductResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDataProductResponse.Builder,GetDataProductResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDataProductResponse extends DataZoneResponse implements ToCopyableBuilder<GetDataProductResponse.Builder,GetDataProductResponse>

  • Method Details

    • createdAt

      public final Instant createdAt()

      The timestamp at which the data product is created.

      Returns:
      The timestamp at which the data product is created.

    • createdBy

      public final String createdBy()

      The user who created the data product.

      Returns:
      The user who created the data product.

    • description

      public final String description()

      The description of the data product.

      Returns:
      The description of the data product.

    • domainId

      public final String domainId()

      The ID of the domain where the data product lives.

      Returns:
      The ID of the domain where the data product lives.

    • firstRevisionCreatedAt

      public final Instant firstRevisionCreatedAt()

      The timestamp at which the first revision of the data product is created.

      Returns:
      The timestamp at which the first revision of the data product is created.

    • firstRevisionCreatedBy

      public final String firstRevisionCreatedBy()

      The user who created the first revision of the data product.

      Returns:
      The user who created the first revision of the data product.

    • hasFormsOutput

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

    • formsOutput

      public final List<FormOutput> formsOutput()

      The metadata forms of the data product.

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

      Returns:
      The metadata forms of the data product.

    • hasGlossaryTerms

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

    • glossaryTerms

      public final List<String> glossaryTerms()

      The glossary terms of the data product.

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

      Returns:
      The glossary terms of the data product.

    • id

      public final String id()

      The ID of the data product.

      Returns:
      The ID of the data product.

    • hasItems

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

    • items

      public final List<DataProductItem> items()

      The data assets of the data product.

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

      Returns:
      The data assets of the data product.

    • name

      public final String name()

      The name of the data product.

      Returns:
      The name of the data product.

    • owningProjectId

      public final String owningProjectId()

      The ID of the owning project of the data product.

      Returns:
      The ID of the owning project of the data product.

    • revision

      public final String revision()

      The revision of the data product.

      Returns:
      The revision of the data product.

    • status

      public final DataProductStatus status()

      The status of the data product.

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

      Returns:
      The status of the data product.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the data product.

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

      Returns:
      The status of the data product.
      See Also:

    • toBuilder

      public GetDataProductResponse.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<GetDataProductResponse.Builder,GetDataProductResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDataProductResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.