Class SharedResource

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

Represents a resource that is shared with the broker, including its type, ARN, and current status.

See Also:

  • Method Details

    • hasDnsNames

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

    • dnsNames

      public final List<String> dnsNames()

      The DNS names accessible by the broker.

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

      Returns:
      The DNS names accessible by the broker.

    • error

      public final SharedResourceError error()

      Information on the error encountered by the resource.

      Returns:
      Information on the error encountered by the resource.

    • resourceArn

      public final String resourceArn()

      The ARN of the shared resource.

      Returns:
      The ARN of the shared resource.

    • hasResourceShareArns

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

    • resourceShareArns

      public final List<String> resourceShareArns()

      The resource share ARNs to which the resource belongs.

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

      Returns:
      The resource share ARNs to which the resource belongs.

    • status

      public final SharedResourceStatus status()

      The status of the shared resource.

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

      Returns:
      The status of the shared resource.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the shared resource.

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

      Returns:
      The status of the shared resource.
      See Also:

    • type

      public final SharedResourceType type()

      The type of shared resource.

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

      Returns:
      The type of shared resource.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of shared resource.

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

      Returns:
      The type of shared resource.
      See Also:

    • toBuilder

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

    • builder

      public static SharedResource.Builder builder()

    • serializableBuilderClass

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