Class GetOpportunityResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.partnercentralselling.model.PartnerCentralSellingResponse
software.amazon.awssdk.services.partnercentralselling.model.GetOpportunityResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetOpportunityResponse.Builder,GetOpportunityResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetOpportunityResponse extends PartnerCentralSellingResponse implements ToCopyableBuilder<GetOpportunityResponse.Builder,GetOpportunityResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that uniquely identifies the opportunity.

      Returns:
      The Amazon Resource Name (ARN) that uniquely identifies the opportunity.

    • catalog

      public final String catalog()

      Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

      Returns:
      Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity information is retrieved from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure and isolated testing environment.

    • createdDate

      public final Instant createdDate()

      DateTime when the Opportunity was last created.

      Returns:
      DateTime when the Opportunity was last created.

    • customer

      public final Customer customer()

      Specifies details of the customer associated with the Opportunity.

      Returns:
      Specifies details of the customer associated with the Opportunity.

    • id

      public final String id()

      Read-only, system generated Opportunity unique identifier.

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

    • lastModifiedDate

      public final Instant lastModifiedDate()

      DateTime when the opportunity was last modified.

      Returns:
      DateTime when the opportunity was last modified.

    • lifeCycle

      public final LifeCycle lifeCycle()

      An object that contains lifecycle details for the Opportunity.

      Returns:
      An object that contains lifecycle details for the Opportunity.

    • marketing

      public final Marketing marketing()

      An object that contains marketing details for the Opportunity.

      Returns:
      An object that contains marketing details for the Opportunity.

    • nationalSecurity

      public final NationalSecurity nationalSecurity()

      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity .

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

      Returns:
      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
      See Also:

    • nationalSecurityAsString

      public final String nationalSecurityAsString()

      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity .

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

      Returns:
      Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.
      See Also:

    • hasOpportunityTeam

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

    • opportunityTeam

      public final List<Contact> opportunityTeam()

      Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

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

      Returns:
      Represents the internal team handling the opportunity. Specify the members involved in collaborating on this opportunity within the partner's organization.

    • opportunityType

      public final OpportunityType opportunityType()

      Specifies the opportunity type as 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, which helps to ensure service continuity.

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

      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 the opportunity type as 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, which helps to ensure service continuity.

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

      See Also:

    • opportunityTypeAsString

      public final String opportunityTypeAsString()

      Specifies the opportunity type as 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, which helps to ensure service continuity.

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

      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 the opportunity type as 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, which helps to ensure service continuity.

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

      See Also:

    • 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.

      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.

    • primaryNeedsFromAws

      public final List<PrimaryNeedFromAws> primaryNeedsFromAws()

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

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

      Returns:
      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

    • hasPrimaryNeedsFromAws

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

    • primaryNeedsFromAwsAsStrings

      public final List<String> primaryNeedsFromAwsAsStrings()

      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

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

      Returns:
      Identifies the type of support the partner needs from Amazon Web Services.

      Valid values:

      • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

      • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

      • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

      • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

      • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

      • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

      • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

      • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

    • project

      public final Project project()

      An object that contains project details summary for the Opportunity.

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

    • relatedEntityIdentifiers

      public final RelatedEntityIdentifiers relatedEntityIdentifiers()

      Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

      Returns:
      Provides information about the associations of other entities with the opportunity. These entities include identifiers for AWSProducts, Partner Solutions, and AWSMarketplaceOffers.

    • softwareRevenue

      public final SoftwareRevenue softwareRevenue()

      Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

      Returns:
      Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

    • toBuilder

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

    • builder

      public static GetOpportunityResponse.Builder builder()

    • serializableBuilderClass

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