com.oracle.bmc.resourcemanager.requests

Class ListJobsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.resourcemanager.requests.ListJobsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180917")
public class ListJobsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListJobsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListJobsRequest.Builder
static class	ListJobsRequest.SortBy The field to use when sorting returned resources.
static class	ListJobsRequest.SortOrder The sort order to use when sorting returned resources.

Constructor Summary

Constructors

Constructor and Description
ListJobsRequest()

Method Summary

Modifier and Type	Method and Description
static ListJobsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() A filter to return only resources that exist in the compartment, identified by OCID.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
String	getId() The OCID on which to query for jobs.
Job.LifecycleState	getLifecycleState() A filter that returns all resources that match the specified lifecycle state.
Integer	getLimit() The number of items returned in a paginated List call.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() The value of the opc-next-page response header from the preceding List call.
ListJobsRequest.SortBy	getSortBy() The field to use when sorting returned resources.
ListJobsRequest.SortOrder	getSortOrder() The sort order to use when sorting returned resources.
String	getStackId() The stack OCID on which to filter.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListJobsRequest.Builder	toBuilder() Return an instance of ListJobsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListJobsRequest

public ListJobsRequest()

Method Detail

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

getCompartmentId

public String getCompartmentId()

A filter to return only resources that exist in the compartment, identified by OCID.

getStackId

public String getStackId()

The stack OCID on which to filter.

getId

public String getId()

The OCID on which to query for jobs.

getLifecycleState

public Job.LifecycleState getLifecycleState()

A filter that returns all resources that match the specified lifecycle state. The state value is case-insensitive.

Allowable values: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED

getDisplayName

public String getDisplayName()

A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

getSortBy

public ListJobsRequest.SortBy getSortBy()

The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

getSortOrder

public ListJobsRequest.SortOrder getSortOrder()

The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

getLimit

public Integer getLimit()

The number of items returned in a paginated List call. For information about pagination, see List Pagination.

getPage

public String getPage()

The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

toBuilder

public ListJobsRequest.Builder toBuilder()

Return an instance of ListJobsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListJobsRequest.Builder that allows you to modify request properties.

builder

public static ListJobsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>