Class GetPaymentManagerResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPaymentManagerResponse.Builder,GetPaymentManagerResponse>

@Generated("software.amazon.awssdk:codegen") public final class GetPaymentManagerResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetPaymentManagerResponse.Builder,GetPaymentManagerResponse>
  • Method Details

    • paymentManagerArn

      public final String paymentManagerArn()

      The Amazon Resource Name (ARN) of the payment manager.

      Returns:
      The Amazon Resource Name (ARN) of the payment manager.
    • paymentManagerId

      public final String paymentManagerId()

      The unique identifier of the payment manager.

      Returns:
      The unique identifier of the payment manager.
    • name

      public final String name()

      The name of the payment manager.

      Returns:
      The name of the payment manager.
    • description

      public final String description()

      The description of the payment manager.

      Returns:
      The description of the payment manager.
    • authorizerType

      public final PaymentsAuthorizerType authorizerType()

      The type of authorizer used by the payment manager.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

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

      Returns:
      The type of authorizer used by the payment manager.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:
    • authorizerTypeAsString

      public final String authorizerTypeAsString()

      The type of authorizer used by the payment manager.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

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

      Returns:
      The type of authorizer used by the payment manager.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      See Also:
    • authorizerConfiguration

      public final AuthorizerConfiguration authorizerConfiguration()
      Returns the value of the AuthorizerConfiguration property for this object.
      Returns:
      The value of the AuthorizerConfiguration property for this object.
    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
    • workloadIdentityDetails

      public final WorkloadIdentityDetails workloadIdentityDetails()
      Returns the value of the WorkloadIdentityDetails property for this object.
      Returns:
      The value of the WorkloadIdentityDetails property for this object.
    • createdAt

      public final Instant createdAt()

      The timestamp when the payment manager was created.

      Returns:
      The timestamp when the payment manager was created.
    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp when the payment manager was last updated.

      Returns:
      The timestamp when the payment manager was last updated.
    • status

      public final PaymentManagerStatus status()

      The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

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

      Returns:
      The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
      See Also:
    • statusAsString

      public final String statusAsString()

      The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

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

      Returns:
      The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
      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()

      The tags associated with the payment manager.

      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 associated with the payment manager.
    • 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<GetPaymentManagerResponse.Builder,GetPaymentManagerResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static GetPaymentManagerResponse.Builder builder()
    • serializableBuilderClass

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