Interface GetResourceSnapshotJobResponse.Builder

    • Method Detail

      • arn

        GetResourceSnapshotJobResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the snapshot job. This globally unique identifier can be used for resource-specific operations across AWS services.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • catalog

        GetResourceSnapshotJobResponse.Builder catalog​(String catalog)

        The catalog in which the snapshot job was created. This will match the Catalog specified in the request.

        Parameters:
        catalog - The catalog in which the snapshot job was created. This will match the Catalog specified in the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdAt

        GetResourceSnapshotJobResponse.Builder createdAt​(Instant createdAt)

        The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

        Parameters:
        createdAt - The date and time when the snapshot job was created in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • engagementId

        GetResourceSnapshotJobResponse.Builder engagementId​(String engagementId)

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

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

        GetResourceSnapshotJobResponse.Builder id​(String id)

        The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.

        Parameters:
        id - The unique identifier of the snapshot job. This matches the ResourceSnapshotJobIdentifier provided in the request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastFailure

        GetResourceSnapshotJobResponse.Builder lastFailure​(String lastFailure)

        If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.

        Parameters:
        lastFailure - If the job has encountered any failures, this field contains the error message from the most recent failure. This can be useful for troubleshooting issues with the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastSuccessfulExecutionDate

        GetResourceSnapshotJobResponse.Builder lastSuccessfulExecutionDate​(Instant lastSuccessfulExecutionDate)

        The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"

        Parameters:
        lastSuccessfulExecutionDate - The date and time of the last successful execution of the job, in ISO 8601 format (UTC). Example: "2023-05-01T20:37:46Z"
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • resourceArn

        GetResourceSnapshotJobResponse.Builder resourceArn​(String resourceArn)

        The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.

        Parameters:
        resourceArn - The Amazon Resource Name (ARN) of the resource being snapshotted. This provides a globally unique identifier for the resource across AWS.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • resourceId

        GetResourceSnapshotJobResponse.Builder resourceId​(String resourceId)

        The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.

        Parameters:
        resourceId - The identifier of the specific resource being snapshotted. The format might vary depending on the ResourceType.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • resourceSnapshotTemplateName

        GetResourceSnapshotJobResponse.Builder resourceSnapshotTemplateName​(String resourceSnapshotTemplateName)

        The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.

        Parameters:
        resourceSnapshotTemplateName - The name of the template used for creating the snapshot. This is the same as the template name. It defines the structure and content of the snapshot.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • resourceType

        GetResourceSnapshotJobResponse.Builder resourceType​(String resourceType)

        The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

        Parameters:
        resourceType - The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResourceType, ResourceType
      • resourceType

        GetResourceSnapshotJobResponse.Builder resourceType​(ResourceType resourceType)

        The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.

        Parameters:
        resourceType - The type of resource being snapshotted. This would have "Opportunity" as a value as it is dependent on the supported resource type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResourceType, ResourceType
      • status

        GetResourceSnapshotJobResponse.Builder status​(String status)

        The current status of the snapshot job. Valid values:

        • STOPPED: The job is not currently running.

        • RUNNING: The job is actively executing.

        Parameters:
        status - The current status of the snapshot job. Valid values:

        • STOPPED: The job is not currently running.

        • RUNNING: The job is actively executing.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ResourceSnapshotJobStatus, ResourceSnapshotJobStatus