Class DisassociateOpportunityRequest
- 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.DisassociateOpportunityRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DisassociateOpportunityRequest.Builder,DisassociateOpportunityRequest>
@Generated("software.amazon.awssdk:codegen") public final class DisassociateOpportunityRequest extends PartnerCentralSellingRequest implements ToCopyableBuilder<DisassociateOpportunityRequest.Builder,DisassociateOpportunityRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDisassociateOpportunityRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DisassociateOpportunityRequest.Builderbuilder()Stringcatalog()Specifies the catalog associated with the request.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringopportunityIdentifier()The opportunity's unique identifier for when you want to disassociate it from related entities.StringrelatedEntityIdentifier()The related entity's identifier that you want to disassociate from the opportunity.RelatedEntityTyperelatedEntityType()The type of the entity that you're disassociating from the opportunity.StringrelatedEntityTypeAsString()The type of the entity that you're disassociating from the opportunity.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DisassociateOpportunityRequest.Builder>serializableBuilderClass()DisassociateOpportunityRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
catalog
public final String catalog()
Specifies the catalog associated with the request. This field takes a string value from a predefined list:
AWSorSandbox. The catalog determines which environment the opportunity disassociation is made in. UseAWSto disassociate opportunities in the Amazon Web Services catalog, andSandboxfor testing in secure, isolated environments.- Returns:
- Specifies the catalog associated with the request. This field takes a string value from a predefined
list:
AWSorSandbox. The catalog determines which environment the opportunity disassociation is made in. UseAWSto disassociate opportunities in the Amazon Web Services catalog, andSandboxfor testing in secure, isolated environments.
-
opportunityIdentifier
public final String opportunityIdentifier()
The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.
- Returns:
- The opportunity's unique identifier for when you want to disassociate it from related entities. This
identifier helps to ensure that the correct opportunity is updated.
Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.
-
relatedEntityIdentifier
public final String relatedEntityIdentifier()
The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.
For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.
- Returns:
- The related entity's identifier that you want to disassociate from the opportunity. Depending on the type
of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed
through Amazon Web Services Marketplace.
For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.
Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.
-
relatedEntityType
public final RelatedEntityType relatedEntityType()
The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
If the service returns an enum value that is not available in the current SDK version,
relatedEntityTypewill returnRelatedEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrelatedEntityTypeAsString().- Returns:
- The type of the entity that you're disassociating from the opportunity. When you specify the entity type,
it helps the system correctly process the disassociation request to ensure that the right connections are
removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
- See Also:
RelatedEntityType
-
relatedEntityTypeAsString
public final String relatedEntityTypeAsString()
The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
If the service returns an enum value that is not available in the current SDK version,
relatedEntityTypewill returnRelatedEntityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromrelatedEntityTypeAsString().- Returns:
- The type of the entity that you're disassociating from the opportunity. When you specify the entity type,
it helps the system correctly process the disassociation request to ensure that the right connections are
removed.
Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.
Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.
- See Also:
RelatedEntityType
-
toBuilder
public DisassociateOpportunityRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DisassociateOpportunityRequest.Builder,DisassociateOpportunityRequest>- Specified by:
toBuilderin classPartnerCentralSellingRequest
-
builder
public static DisassociateOpportunityRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DisassociateOpportunityRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-