Package com.oracle.bmc.lustrefilestorage.model

Class SyncJob

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250228")
public final class SyncJob
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details associated with sync job runs.
    Note: Objects should always be created or deserialized using the SyncJob.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SyncJob.Builder, which maintain a set of all explicitly set fields called SyncJob.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the sync job.
        Returns:
        the value

      • getParentId

        public String getParentId()
        The OCID of the Object Storage link.
        Returns:
        the value

      • getJobType

        public SyncJob.JobType getJobType()
        The type of the sync job.
        Returns:
        the value

      • getLifecycleState

        public SyncJob.LifecycleState getLifecycleState()
        The current state of the sync job.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message that describes the current state of the sync job in more detail.

        For example, can be used to provide actionable information for a resource in the Failed state.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • getIsOverwrite

        public Boolean getIsOverwrite()
        The flag is an identifier to tell whether this specific job run has overwrite enabled.

        If isOverwrite is false, the file to be imported or exported will be skipped if it already exists. If isOverwrite is true, the file to be imported or exported will be overwritten if it already exists.

        Returns:
        the value

      • getTotalObjectsScanned

        public Long getTotalObjectsScanned()
        Total object count for scanned files for import or export as part of this sync job.
        Returns:
        the value

      • getObjectsTransferred

        public Long getObjectsTransferred()
        Count of total files that transferred successfully.
        Returns:
        the value

      • getBytesTransferred

        public Long getBytesTransferred()
        Bytes transferred during the sync.

        This value changes while the sync is still in progress.

        Returns:
        the value

      • getSkippedErrorCount

        public Long getSkippedErrorCount()
        Count of files or objects that failed to export or import due to errors.
        Returns:
        the value

      • getTimeStarted

        public Date getTimeStarted()
        The date and time the job was started, expressed in RFC 3339 timestamp format.

        Example: 2020-07-25T21:10:29.600Z

        Returns:
        the value

      • getTimeFinished

        public Date getTimeFinished()
        The date and time the job finished, expressed in RFC 3339 timestamp format.

        Example: 2020-07-25T21:10:29.600Z

        Returns:
        the value

      • getLustreFileSystemPath

        public String getLustreFileSystemPath()
        The path in the Lustre file system used for this Object Storage link.

        Example: myFileSystem/mount/myDirectory

        Returns:
        the value

      • getObjectStoragePath

        public String getObjectStoragePath()
        The Object Storage namespace and bucket name, including optional object prefix string, to use as the source for imports or destination for exports.

        Example: objectStorageNamespace:/bucketName/optionalFolder/optionalPrefix

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel