Spectra Logic

1-800-833-1132 : 1-303-449-6400

Get Job Chunks Ready for Processing

Description

Get a list of all job chunks for a given job that are ready for client processing.

For PUT jobs, this will allocate a working window of job chunks, if possible, and return the job chunks that the client can upload. Any chunk returned is fully allocated, meaning that you do not have to handle HTTP 307 retries on subsequent PUTs for the chunks. Retries adversely impact BlackPearl gateway performance and require you to provide the object data stream for every PUT retry.

For GET jobs, this will respond with which job chunks have been loaded into cache and are ready for download.

Requests

Syntax

GET http[s]://{datapathDNSname}/_rest_/job_chunk/?job={string}[&preferred_number_of_chunks={32-bit integer}]

Request Parameters

Parameter	Description	Required
job	The UUID or a unique attribute for the job for which you want job chunks listed. See Get Jobs.	yes
preferred_number_of_chunks	The maximum number of chunks to return. The default is 3.	no

Responses

Response Elements

<MasterObjectList
   Aggregating="TRUE|FALSE"
   BucketName="{string}"
   CachedSizeInBytes="{64-bit integer}"
   ChunkClientProcessingOrderGuarantee="IN_ORDER|NONE"
   CompletedSizeInBytes="{64-bit integer}"
   JobId="{string}"
   Naked="TRUE|FALSE"
   Name="{string}"
   OriginalSizeInBytes="{64-bit integer}"
   Priority="CRITICAL|URGENT|HIGH|NORMAL|LOW|BACKGROUND"

   RequestType="GET|PUT|VERIFY"

   StartDate="{YYYY-MM-DDThh:mm:ss.xxxZ}"

   Status="IN_PROGRESS|COMPLETED|CANCELED"
   UserId="{string}"
   UserName="{string}"
   <Nodes>
      <Node
         EndPoint="{string}" Id="{string}"/>
      ...
   </Nodes>
   <Objects
      ChunkId="{string}"
      ChunkNumber="{32-bit integer}">
      <Object
         InCache="TRUE|FALSE"
         Latest="TRUE|FALSE"
         Length="{64-bit integer}"
         Name="{string}"
         Offset="{64-bit integer}"/>
         Version="{64-bit integer}"
      ...
   </Objects>
   ...
</MasterObjectList>

where the response elements are defined as follows:

Parameter	Description
MasterObjectList	The container for the response.
Aggregating	Whether the job can have additional work appended to it. Jobs can aggregate if they are created with the aggregating request parameter set to TRUE (Naked=FALSE) or if they are created by the BlackPearl gateway in response to Amazon S3 PUT and GET requests (Naked=TRUE). Values: TRUE, FALSE
BucketName	The name of the bucket that is acted on by the job request.
CachedSizeInBytes	The amount of data that has been transferred to the cache for this job. For RequestType=PUT, this is the amount of data successfully transferred to the BlackPearl Deep Storage Gateway from the client. For RequestType=GET, this the amount of data either in cache originally, or loaded into cache from the permanent data store. For RequestType=VERIFY, this the amount of data loaded into cache from the permanent data store.
ChunkClient ProcessingOrder Guarantee	Specifies whether the job chunks will be processed in order. Values: IN_ORDER, NONE
CompletedSizeIn Bytes	The amount of data that has been transferred to the cache for this job. For RequestType=PUT, this is the amount of data successfully transferred to the BlackPearl Deep Storage Gateway from the client. For RequestType=GET, this the amount of data either in cache originally, or loaded into cache from the permanent data store. For RequestType=VERIFY, this the amount of data loaded into cache from the permanent data store.
JobId	The UUID for the job.
Naked	Whether the job was created as the result of a native S3 command (TRUE) or a Create Get/Put/Verify Job command (FALSE). Values: TRUE, FALSE
Name	The name assigned to the job for tracking.
OriginalSizeInBytes	The full size of the job.
Priority	The priority for processing this job. The job priority determines the resources assigned and the processing order. Values: CRITICAL, URGENT, HIGH, NORMAL, LOW, BACKGROUND
RequestType	Type of job request. Values: GET, PUT, VERIFY
StartDate	The date and time the job was started in the format YYYY-MM-DDThh:mm:ss.xxxZ.
Status	The current status of the job. Values: § IN_PROGRESS — The job is currently running. § COMPLETED — The job completed. § CANCELED — The job was canceled by the user or automatically due to internal timeouts.
UserId	The UUID for the user who initiated the job.
UserName	The username of the user who initiated the job.
Nodes	A container for information about all BlackPearl nodes.
Node	A container for information about a single BlackPearl node.
EndPoint	The IP address or DNS name of the BlackPearl node.
Id	The UUID for the node.
Objects	Container for information about the objects in one chunk.
ChunkId	The UUID for the job chunk.
ChunkNumber	The position of the chunk within the job.
Object	The container for information about a single object.
InCache	Indicates if the object is currently in cache on the BlackPearl Deep Storage Gateway. Values: TRUE, FALSE
Latest	Whether this version of the object is the latest. Values: TRUE, FALSE
Length	The length in bytes of the object.
Name	The name of the object.
Offset	The offset in bytes from the start of the object.
Version	The version number of the object.

Example

Sample Request

This request GETs a list of all job chunks ready to process for the job with the UUID 63c605c4-8f8f-47c8-87ec-5735fbd53218.

GET http://blackpearl-hostname/_rest_/job_chunk/?job=63c605c4-8f8f-47c8-87ec-5735fbd53218 HTTP/1.1

Sample Response

HTTP/1.1 200 OK
<MasterObjectList
   Aggregating="FALSE"
   BucketName="default_bucket_name"
   CachedSizeInBytes="0"
   ChunkClientProcessingOrderGuarantee="IN_ORDER"
   CompletedSizeInBytes="0"
   JobId="63c605c4-8f8f-47c8-87ec-5735fbd53218"
   Naked="FALSE"
   Name="Untitled"
   OriginalSizeInBytes="0"
   Priority="URGENT"
   RequestType="PUT"
   StartDate="2015-08-10T22:58:42.000Z"
   Status="IN_PROGRESS"
   UserId="3b478ebf-6076-4b01-a763-f35cadee8e77"
   UserName="default_user_name">
   <Nodes>
      <Node EndPoint="blackpearl-hostname"
      Id="1cab8662-7645-444e-ad2b-f62ff79edb5e"/>
   </Nodes>
   <Objects ChunkId="7a8fd827-072b-43be-9e28-821fca542a5f"
      ChunkNumber="1">
      <Object InCache="FALSE" Latest="TRUE" Length="1000"
         Name="o1" Offset="0" Version="1"/>
   </Objects>
</MasterObjectList>