Class DescribeComponentResponse

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

  • Method Details

    • arn

      public final String arn()

      The ARN of the component version.

      Returns:
      The ARN of the component version.

    • componentName

      public final String componentName()

      The name of the component.

      Returns:
      The name of the component.

    • componentVersion

      public final String componentVersion()

      The version of the component.

      Returns:
      The version of the component.

    • creationTimestamp

      public final Instant creationTimestamp()

      The time at which the component was created, expressed in ISO 8601 format.

      Returns:
      The time at which the component was created, expressed in ISO 8601 format.

    • publisher

      public final String publisher()

      The publisher of the component version.

      Returns:
      The publisher of the component version.

    • description

      public final String description()

      The description of the component version.

      Returns:
      The description of the component version.

    • status

      public final CloudComponentStatus status()

      The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

      Returns:
      The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.

    • hasPlatforms

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

    • platforms

      public final List<ComponentPlatform> platforms()

      The platforms that the component version supports.

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

      Returns:
      The platforms that the component version supports.

    • 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 Map<String,String> tags()

      A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

      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:
      A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

    • toBuilder

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

    • builder

      public static DescribeComponentResponse.Builder builder()

    • serializableBuilderClass

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