com.oracle.bmc.resourcemanager.requests

Class CancelJobRequest

java.lang.Object

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

com.oracle.bmc.resourcemanager.requests.CancelJobRequest

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

Example: Click here to see how to use CancelJobRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CancelJobRequest.Builder

Constructor Summary

Constructors

Constructor and Description
CancelJobRequest()

Method Summary

Modifier and Type	Method and Description
static CancelJobRequest.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	getIfMatch() For optimistic concurrency control.
Boolean	getIsForced() Indicates whether a forced cancellation is requested for the job while it was running.
String	getJobId() The OCID of the job.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
CancelJobRequest.Builder	toBuilder() Return an instance of CancelJobRequest.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

CancelJobRequest

public CancelJobRequest()

Method Detail

getJobId

public String getJobId()

The OCID of the job.

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.

getIfMatch

public String getIfMatch()

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

getIsForced

public Boolean getIsForced()

Indicates whether a forced cancellation is requested for the job while it was running. A forced cancellation can result in an incorrect state file. For example, the state file might not reflect the exact state of the provisioned resources.

toBuilder

public CancelJobRequest.Builder toBuilder()

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

Returns:

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

builder

public static CancelJobRequest.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>