Interface GetResourceSnapshotRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>, PartnerCentralSellingRequest.Builder, SdkBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetResourceSnapshotRequest
@Mutable @NotThreadSafe public static interface GetResourceSnapshotRequest.Builder extends PartnerCentralSellingRequest.Builder, SdkPojo, CopyableBuilder<GetResourceSnapshotRequest.Builder,GetResourceSnapshotRequest>

  • Method Details

    • catalog

      GetResourceSnapshotRequest.Builder catalog(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • engagementIdentifier

      GetResourceSnapshotRequest.Builder engagementIdentifier(String engagementIdentifier)

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

      Parameters:
      engagementIdentifier - The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceType

      GetResourceSnapshotRequest.Builder resourceType(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceType

      GetResourceSnapshotRequest.Builder resourceType(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceIdentifier

      GetResourceSnapshotRequest.Builder resourceIdentifier(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • resourceSnapshotTemplateIdentifier

      GetResourceSnapshotRequest.Builder resourceSnapshotTemplateIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • revision

      GetResourceSnapshotRequest.Builder revision(Integer revision)

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

      Parameters:
      revision - Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetResourceSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetResourceSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.