Class GetResourceSnapshotRequest

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.GetResourceSnapshotRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetResourceSnapshotRequest extends PartnerCentralSellingRequest implements ToCopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>

  • Method Details

    • catalog

      public final String catalog()

      Specifies the catalog related to the request. Valid values are:

      • AWS: Retrieves the snapshot from the production AWS environment.

      • Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.

      Returns:
      Specifies the catalog related to the request. Valid values are:

      • AWS: Retrieves the snapshot from the production AWS environment.

      • Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.

    • engagementIdentifier

      public final String engagementIdentifier()

      The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

      Returns:
      The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

    • resourceIdentifier

      public final String resourceIdentifier()

      The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

      Returns:
      The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

    • resourceSnapshotTemplateIdentifier

      public final String resourceSnapshotTemplateIdentifier()

      he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

      Returns:
      he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

    • resourceType

      public final ResourceType resourceType()

      Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

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

      Returns:
      Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

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

      Returns:
      Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.
      See Also:

    • revision

      public final Integer revision()

      Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

      Returns:
      Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

    • toBuilder

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

    • builder

      public static GetResourceSnapshotRequest.Builder builder()

    • serializableBuilderClass

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