Class OpportunitySummary

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

An object that contains an Opportunity's subset of fields.

See Also:

  • Method Details

    • catalog

      public final String catalog()

      Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

      Returns:
      Specifies the catalog associated with the opportunity, either AWS or Sandbox. This indicates the environment in which the opportunity is managed.

    • id

      public final String id()

      Read-only, system-generated Opportunity unique identifier.

      Returns:
      Read-only, system-generated Opportunity unique identifier.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

      Returns:
      The Amazon Resource Name (ARN) for the opportunity. This globally unique identifier can be used for IAM policies and cross-service references.

    • partnerOpportunityIdentifier

      public final String partnerOpportunityIdentifier()

      Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

      Returns:
      Specifies the Opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner. It allows partners to link an opportunity to their CRM.

    • opportunityType

      public final OpportunityType opportunityType()

      Specifies opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

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

      Returns:
      Specifies opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      See Also:

    • opportunityTypeAsString

      public final String opportunityTypeAsString()

      Specifies opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

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

      Returns:
      Specifies opportunity type as a renewal, new, or expansion.

      Opportunity types:

      • New Opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

      • Renewal Opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

      • Expansion Opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

      See Also:

    • lastModifiedDate

      public final Instant lastModifiedDate()

      DateTime when the Opportunity was last modified.

      Returns:
      DateTime when the Opportunity was last modified.

    • createdDate

      public final Instant createdDate()

      DateTime when the Opportunity was last created.

      Returns:
      DateTime when the Opportunity was last created.

    • lifeCycle

      public final LifeCycleSummary lifeCycle()

      An object that contains the Opportunity's lifecycle details.

      Returns:
      An object that contains the Opportunity's lifecycle details.

    • customer

      public final CustomerSummary customer()

      An object that contains the Opportunity's customer details.

      Returns:
      An object that contains the Opportunity's customer details.

    • project

      public final ProjectSummary project()

      An object that contains the Opportunity's project details summary.

      Returns:
      An object that contains the Opportunity's project details summary.

    • toBuilder

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

    • builder

      public static OpportunitySummary.Builder builder()

    • serializableBuilderClass

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