Class Accessor

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

The properties of the Accessor.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the accessor.

      Returns:
      The unique identifier of the accessor.

    • type

      public final AccessorType type()

      The type of the accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

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

      Returns:
      The type of the accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

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

      Returns:
      The type of the accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

      See Also:

    • billingToken

      public final String billingToken()

      The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.

      Returns:
      The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.

    • status

      public final AccessorStatus status()

      The current status of the accessor.

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

      Returns:
      The current status of the accessor.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the accessor.

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

      Returns:
      The current status of the accessor.
      See Also:

    • creationDate

      public final Instant creationDate()

      The creation date and time of the accessor.

      Returns:
      The creation date and time of the accessor.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

      Returns:
      The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

    • 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()

      The tags assigned to the Accessor.

      For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric 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:
      The tags assigned to the Accessor.

      For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

    • networkType

      public final AccessorNetworkType networkType()

      The blockchain network that the Accessor token is created for.

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

      Returns:
      The blockchain network that the Accessor token is created for.
      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      The blockchain network that the Accessor token is created for.

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

      Returns:
      The blockchain network that the Accessor token is created for.
      See Also:

    • toBuilder

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

    • builder

      public static Accessor.Builder builder()

    • serializableBuilderClass

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