Class CreateResourceSnapshotRequest

    • Method Detail

      • catalog

        public final String catalog()

        Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

        Returns:
        Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.
      • clientToken

        public final String clientToken()

        Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

        Returns:
        Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.
      • engagementIdentifier

        public final String engagementIdentifier()

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

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

        public final String resourceIdentifier()

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

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

        public final String resourceSnapshotTemplateIdentifier()

        The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

        Returns:
        The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.
      • resourceType

        public final ResourceType resourceType()

        Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

        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 for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.
        See Also:
        ResourceType
      • resourceTypeAsString

        public final String resourceTypeAsString()

        Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

        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 for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.
        See Also:
        ResourceType
      • 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