Class AssociateOpportunityRequest

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

  • Method Details

    • 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 association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

      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 association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

    • opportunityIdentifier

      public final String opportunityIdentifier()

      Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

      Returns:
      Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

    • relatedEntityIdentifier

      public final String relatedEntityIdentifier()

      Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

      Returns:
      Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

    • relatedEntityType

      public final RelatedEntityType relatedEntityType()

      Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

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

      Returns:
      Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.
      See Also:

    • relatedEntityTypeAsString

      public final String relatedEntityTypeAsString()

      Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

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

      Returns:
      Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.
      See Also:

    • toBuilder

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

    • builder

      public static AssociateOpportunityRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.