Package software.amazon.awssdk.services.managedblockchain.model

Class CreateAccessorRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.managedblockchain.model.ManagedBlockchainRequest
software.amazon.awssdk.services.managedblockchain.model.CreateAccessorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAccessorRequest.Builder,CreateAccessorRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAccessorRequest extends ManagedBlockchainRequest implements ToCopyableBuilder<CreateAccessorRequest.Builder,CreateAccessorRequest>

  • Method Details

    • clientRequestToken

      public final String clientRequestToken()

      This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

      Returns:
      This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

    • accessorType

      public final AccessorType accessorType()

      The type of 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, accessorType will return AccessorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessorTypeAsString().

      Returns:
      The type of accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

      See Also:

    • accessorTypeAsString

      public final String accessorTypeAsString()

      The type of 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, accessorType will return AccessorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from accessorTypeAsString().

      Returns:
      The type of accessor.

      Currently, accessor type is restricted to BILLING_TOKEN.

      See Also:

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

      Tags to assign to the Accessor.

      Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

      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:
      Tags to assign to the Accessor.

      Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

      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.

      We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

      The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

      • when the CreateAccessor action does not set a networkType.

      • to all existing Accessor tokens that were created before the networkType property was introduced.

      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.

      We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

      The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

      • when the CreateAccessor action does not set a networkType.

      • to all existing Accessor tokens that were created before the networkType property was introduced.

      See Also:

    • networkTypeAsString

      public final String networkTypeAsString()

      The blockchain network that the Accessor token is created for.

      We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

      The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

      • when the CreateAccessor action does not set a networkType.

      • to all existing Accessor tokens that were created before the networkType property was introduced.

      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.

      We recommend using the appropriate networkType value for the blockchain network that you are creating the Accessor token for. You cannnot use the value ETHEREUM_MAINNET_AND_GOERLI to specify a networkType for your Accessor token.

      The default value of ETHEREUM_MAINNET_AND_GOERLI is only applied:

      • when the CreateAccessor action does not set a networkType.

      • to all existing Accessor tokens that were created before the networkType property was introduced.

      See Also:

    • toBuilder

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

    • builder

      public static CreateAccessorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAccessorRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.