Class CustomerAgreementSummary

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

Summary for customer-agreement resource.

See Also:

  • Method Details

    • name

      public final String name()

      Name of the customer-agreement resource.

      Returns:
      Name of the customer-agreement resource.

    • arn

      public final String arn()

      ARN of the customer-agreement resource.

      Returns:
      ARN of the customer-agreement resource.

    • id

      public final String id()

      Identifier of the customer-agreement resource.

      Returns:
      Identifier of the customer-agreement resource.

    • agreementArn

      public final String agreementArn()

      ARN of the agreement resource the customer-agreement resource represents.

      Returns:
      ARN of the agreement resource the customer-agreement resource represents.

    • awsAccountId

      public final String awsAccountId()

      AWS account Id that owns the resource.

      Returns:
      AWS account Id that owns the resource.

    • organizationArn

      public final String organizationArn()

      ARN of the organization that owns the resource.

      Returns:
      ARN of the organization that owns the resource.

    • effectiveStart

      public final Instant effectiveStart()

      Timestamp indicating when the agreement became effective.

      Returns:
      Timestamp indicating when the agreement became effective.

    • effectiveEnd

      public final Instant effectiveEnd()

      Timestamp indicating when the agreement was terminated.

      Returns:
      Timestamp indicating when the agreement was terminated.

    • state

      public final CustomerAgreementState state()

      State of the resource.

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

      Returns:
      State of the resource.
      See Also:

    • stateAsString

      public final String stateAsString()

      State of the resource.

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

      Returns:
      State of the resource.
      See Also:

    • description

      public final String description()

      Description of the resource.

      Returns:
      Description of the resource.

    • hasAcceptanceTerms

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

    • acceptanceTerms

      public final List<String> acceptanceTerms()

      Terms required to accept the agreement resource.

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

      Returns:
      Terms required to accept the agreement resource.

    • hasTerminateTerms

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

    • terminateTerms

      public final List<String> terminateTerms()

      Terms required to terminate the customer-agreement resource.

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

      Returns:
      Terms required to terminate the customer-agreement resource.

    • type

      public final AgreementType type()

      Type of the customer-agreement resource.

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

      Returns:
      Type of the customer-agreement resource.
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of the customer-agreement resource.

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

      Returns:
      Type of the customer-agreement resource.
      See Also:

    • toBuilder

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

    • builder

      public static CustomerAgreementSummary.Builder builder()

    • serializableBuilderClass

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