JobProperties Class

  • java.lang.Object
    • com.azure.resourcemanager.databox.fluent.models.JobProperties

Implements

public final class JobProperties
implements JsonSerializable<JobProperties>

Job Properties.

Constructor Summary

Constructor Description
JobProperties()

Creates an instance of JobProperties class.

Method Summary

Modifier and Type Method and Description
String cancellationReason()

Get the cancellationReason property: Reason for cancellation.

JobDeliveryInfo deliveryInfo()

Get the deliveryInfo property: Delivery Info of Job.

JobDeliveryType deliveryType()

Get the deliveryType property: Delivery type of Job.

JobDetails details()

Get the details property: Details of a job run.

CloudError error()

Get the error property: Top level error for the job.

static JobProperties fromJson(JsonReader jsonReader)

Reads an instance of JobProperties from the JsonReader.

Boolean isCancellable()

Get the isCancellable property: Describes whether the job is cancellable or not.

Boolean isCancellableWithoutFee()

Get the isCancellableWithoutFee property: Flag to indicate cancellation of scheduled job.

Boolean isDeletable()

Get the isDeletable property: Describes whether the job is deletable or not.

Boolean isPrepareToShipEnabled()

Get the isPrepareToShipEnabled property: Is Prepare To Ship Enabled on this job.

Boolean isShippingAddressEditable()

Get the isShippingAddressEditable property: Describes whether the shipping address is editable or not.

ReverseShippingDetailsEditStatus reverseShippingDetailsUpdate()

Get the reverseShippingDetailsUpdate property: The Editable status for Reverse Shipping Address and Contact Info.

ReverseTransportPreferenceEditStatus reverseTransportPreferenceUpdate()

Get the reverseTransportPreferenceUpdate property: The Editable status for Reverse Transport preferences.

OffsetDateTime startTime()

Get the startTime property: Time at which the job was started in UTC ISO 8601 format.

StageName status()

Get the status property: Name of the stage which is in progress.

JsonWriter toJson(JsonWriter jsonWriter)
TransferType transferType()

Get the transferType property: Type of the data transfer.

void validate()

Validates the instance.

JobProperties withDeliveryInfo(JobDeliveryInfo deliveryInfo)

Set the deliveryInfo property: Delivery Info of Job.

JobProperties withDeliveryType(JobDeliveryType deliveryType)

Set the deliveryType property: Delivery type of Job.

JobProperties withDetails(JobDetails details)

Set the details property: Details of a job run.

JobProperties withTransferType(TransferType transferType)

Set the transferType property: Type of the data transfer.

Methods inherited from java.lang.Object

Constructor Details

JobProperties

public JobProperties()

Creates an instance of JobProperties class.

Method Details

cancellationReason

public String cancellationReason()

Get the cancellationReason property: Reason for cancellation.

Returns:

the cancellationReason value.

deliveryInfo

public JobDeliveryInfo deliveryInfo()

Get the deliveryInfo property: Delivery Info of Job.

Returns:

the deliveryInfo value.

deliveryType

public JobDeliveryType deliveryType()

Get the deliveryType property: Delivery type of Job.

Returns:

the deliveryType value.

details

public JobDetails details()

Get the details property: Details of a job run. This field will only be sent for expand details filter.

Returns:

the details value.

error

public CloudError error()

Get the error property: Top level error for the job.

Returns:

the error value.

fromJson

public static JobProperties fromJson(JsonReader jsonReader)

Reads an instance of JobProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of JobProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

isCancellable

public Boolean isCancellable()

Get the isCancellable property: Describes whether the job is cancellable or not.

Returns:

the isCancellable value.

isCancellableWithoutFee

public Boolean isCancellableWithoutFee()

Get the isCancellableWithoutFee property: Flag to indicate cancellation of scheduled job.

Returns:

the isCancellableWithoutFee value.

isDeletable

public Boolean isDeletable()

Get the isDeletable property: Describes whether the job is deletable or not.

Returns:

the isDeletable value.

isPrepareToShipEnabled

public Boolean isPrepareToShipEnabled()

Get the isPrepareToShipEnabled property: Is Prepare To Ship Enabled on this job.

Returns:

the isPrepareToShipEnabled value.

isShippingAddressEditable

public Boolean isShippingAddressEditable()

Get the isShippingAddressEditable property: Describes whether the shipping address is editable or not.

Returns:

the isShippingAddressEditable value.

reverseShippingDetailsUpdate

public ReverseShippingDetailsEditStatus reverseShippingDetailsUpdate()

Get the reverseShippingDetailsUpdate property: The Editable status for Reverse Shipping Address and Contact Info.

Returns:

the reverseShippingDetailsUpdate value.

reverseTransportPreferenceUpdate

public ReverseTransportPreferenceEditStatus reverseTransportPreferenceUpdate()

Get the reverseTransportPreferenceUpdate property: The Editable status for Reverse Transport preferences.

Returns:

the reverseTransportPreferenceUpdate value.

startTime

public OffsetDateTime startTime()

Get the startTime property: Time at which the job was started in UTC ISO 8601 format.

Returns:

the startTime value.

status

public StageName status()

Get the status property: Name of the stage which is in progress.

Returns:

the status value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

transferType

public TransferType transferType()

Get the transferType property: Type of the data transfer.

Returns:

the transferType value.

validate

public void validate()

Validates the instance.

withDeliveryInfo

public JobProperties withDeliveryInfo(JobDeliveryInfo deliveryInfo)

Set the deliveryInfo property: Delivery Info of Job.

Parameters:

deliveryInfo - the deliveryInfo value to set.

Returns:

the JobProperties object itself.

withDeliveryType

public JobProperties withDeliveryType(JobDeliveryType deliveryType)

Set the deliveryType property: Delivery type of Job.

Parameters:

deliveryType - the deliveryType value to set.

Returns:

the JobProperties object itself.

withDetails

public JobProperties withDetails(JobDetails details)

Set the details property: Details of a job run. This field will only be sent for expand details filter.

Parameters:

details - the details value to set.

Returns:

the JobProperties object itself.

withTransferType

public JobProperties withTransferType(TransferType transferType)

Set the transferType property: Type of the data transfer.

Parameters:

transferType - the transferType value to set.

Returns:

the JobProperties object itself.

Applies to