JobListDescriptor (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3control.model.JobListDescriptor

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobListDescriptor
extends Object
implements Serializable, Cloneable
```
Contains the configuration and status information for a single job retrieved as part of a job list.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JobListDescriptor()

Constructors
Constructor and Description
`JobListDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobListDescriptor`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` A timestamp indicating when the specified job was created.
`String`	`getDescription()` The user-specified description that was included in the specified job's `Create Job` request.
`String`	`getJobId()` The ID for the specified job.
`String`	`getOperation()` The operation that the specified job is configured to run on each object listed in the manifest.
`Integer`	`getPriority()` The current priority for the specified job.
`JobProgressSummary`	`getProgressSummary()` Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
`String`	`getStatus()` The specified job's current status.
`Date`	`getTerminationDate()` A timestamp indicating when the specified job terminated.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` A timestamp indicating when the specified job was created.
`void`	`setDescription(String description)` The user-specified description that was included in the specified job's `Create Job` request.
`void`	`setJobId(String jobId)` The ID for the specified job.
`void`	`setOperation(String operation)` The operation that the specified job is configured to run on each object listed in the manifest.
`void`	`setPriority(Integer priority)` The current priority for the specified job.
`void`	`setProgressSummary(JobProgressSummary progressSummary)` Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
`void`	`setStatus(String status)` The specified job's current status.
`void`	`setTerminationDate(Date terminationDate)` A timestamp indicating when the specified job terminated.
`String`	`toString()` Returns a string representation of this object.
`JobListDescriptor`	`withCreationTime(Date creationTime)` A timestamp indicating when the specified job was created.
`JobListDescriptor`	`withDescription(String description)` The user-specified description that was included in the specified job's `Create Job` request.
`JobListDescriptor`	`withJobId(String jobId)` The ID for the specified job.
`JobListDescriptor`	`withOperation(OperationName operation)` The operation that the specified job is configured to run on each object listed in the manifest.
`JobListDescriptor`	`withOperation(String operation)` The operation that the specified job is configured to run on each object listed in the manifest.
`JobListDescriptor`	`withPriority(Integer priority)` The current priority for the specified job.
`JobListDescriptor`	`withProgressSummary(JobProgressSummary progressSummary)` Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
`JobListDescriptor`	`withStatus(JobStatus status)` The specified job's current status.
`JobListDescriptor`	`withStatus(String status)` The specified job's current status.
`JobListDescriptor`	`withTerminationDate(Date terminationDate)` A timestamp indicating when the specified job terminated.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - JobListDescriptor
```
public JobListDescriptor()
```
- Method Detail
  - setJobId
```
public void setJobId(String jobId)
```
    The ID for the specified job.
    
    Parameters:
    
    jobId - The ID for the specified job.
  - getJobId
```
public String getJobId()
```
    The ID for the specified job.
    
    Returns:
    
    The ID for the specified job.
  - withJobId
```
public JobListDescriptor withJobId(String jobId)
```
    The ID for the specified job.
    
    Parameters:
    
    jobId - The ID for the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The user-specified description that was included in the specified job's Create Job request.
    
    Parameters:
    
    description - The user-specified description that was included in the specified job's Create Job request.
  - getDescription
```
public String getDescription()
```
    The user-specified description that was included in the specified job's Create Job request.
    
    Returns:
    
    The user-specified description that was included in the specified job's Create Job request.
  - withDescription
```
public JobListDescriptor withDescription(String description)
```
    The user-specified description that was included in the specified job's Create Job request.
    
    Parameters:
    
    description - The user-specified description that was included in the specified job's Create Job request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperation
```
public void setOperation(String operation)
```
    The operation that the specified job is configured to run on each object listed in the manifest.
    
    Parameters:
    
    operation - The operation that the specified job is configured to run on each object listed in the manifest.
    
    See Also:
    
    OperationName
  - getOperation
```
public String getOperation()
```
    The operation that the specified job is configured to run on each object listed in the manifest.
    
    Returns:
    
    The operation that the specified job is configured to run on each object listed in the manifest.
    
    See Also:
    
    OperationName
  - withOperation
```
public JobListDescriptor withOperation(String operation)
```
    The operation that the specified job is configured to run on each object listed in the manifest.
    
    Parameters:
    
    operation - The operation that the specified job is configured to run on each object listed in the manifest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OperationName
  - withOperation
```
public JobListDescriptor withOperation(OperationName operation)
```
    The operation that the specified job is configured to run on each object listed in the manifest.
    
    Parameters:
    
    operation - The operation that the specified job is configured to run on each object listed in the manifest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OperationName
  - setPriority
```
public void setPriority(Integer priority)
```
    The current priority for the specified job.
    
    Parameters:
    
    priority - The current priority for the specified job.
  - getPriority
```
public Integer getPriority()
```
    The current priority for the specified job.
    
    Returns:
    
    The current priority for the specified job.
  - withPriority
```
public JobListDescriptor withPriority(Integer priority)
```
    The current priority for the specified job.
    
    Parameters:
    
    priority - The current priority for the specified job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The specified job's current status.
    
    Parameters:
    
    status - The specified job's current status.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The specified job's current status.
    
    Returns:
    
    The specified job's current status.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobListDescriptor withStatus(String status)
```
    The specified job's current status.
    
    Parameters:
    
    status - The specified job's current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public JobListDescriptor withStatus(JobStatus status)
```
    The specified job's current status.
    
    Parameters:
    
    status - The specified job's current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp indicating when the specified job was created.
    
    Parameters:
    
    creationTime - A timestamp indicating when the specified job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp indicating when the specified job was created.
    
    Returns:
    
    A timestamp indicating when the specified job was created.
  - withCreationTime
```
public JobListDescriptor withCreationTime(Date creationTime)
```
    A timestamp indicating when the specified job was created.
    
    Parameters:
    
    creationTime - A timestamp indicating when the specified job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTerminationDate
```
public void setTerminationDate(Date terminationDate)
```
    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
    
    Parameters:
    
    terminationDate - A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
  - getTerminationDate
```
public Date getTerminationDate()
```
    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
    
    Returns:
    
    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
  - withTerminationDate
```
public JobListDescriptor withTerminationDate(Date terminationDate)
```
    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
    
    Parameters:
    
    terminationDate - A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgressSummary
```
public void setProgressSummary(JobProgressSummary progressSummary)
```
    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
    
    Parameters:
    
    progressSummary - Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
  - getProgressSummary
```
public JobProgressSummary getProgressSummary()
```
    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
    
    Returns:
    
    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
  - withProgressSummary
```
public JobListDescriptor withProgressSummary(JobProgressSummary progressSummary)
```
    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
    
    Parameters:
    
    progressSummary - Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public JobListDescriptor clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class JobListDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JobListDescriptor

Method Detail

setJobId

getJobId

withJobId

setDescription

getDescription

withDescription

setOperation

getOperation

withOperation

withOperation

setPriority

getPriority

withPriority

setStatus

getStatus

withStatus

withStatus

setCreationTime

getCreationTime

withCreationTime

setTerminationDate

getTerminationDate

withTerminationDate

setProgressSummary

getProgressSummary

withProgressSummary

toString

equals

hashCode

clone