Class SyncJob.Builder

  • Enclosing class:
    SyncJob

    public static class SyncJob.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • id

        public SyncJob.Builder id​(String id)
        The OCID of the sync job.
        Parameters:
        id - the value to set
        Returns:
        this builder
      • parentId

        public SyncJob.Builder parentId​(String parentId)
        The OCID of the Object Storage link.
        Parameters:
        parentId - the value to set
        Returns:
        this builder
      • jobType

        public SyncJob.Builder jobType​(SyncJob.JobType jobType)
        The type of the sync job.
        Parameters:
        jobType - the value to set
        Returns:
        this builder
      • lifecycleState

        public SyncJob.Builder lifecycleState​(SyncJob.LifecycleState lifecycleState)
        The current state of the sync job.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public SyncJob.Builder lifecycleDetails​(String lifecycleDetails)
        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.

        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder
      • freeformTags

        public SyncJob.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder
      • definedTags

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

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder
      • systemTags

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

        Each key is predefined and scoped to a namespace.

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

        Parameters:
        systemTags - the value to set
        Returns:
        this builder
      • isOverwrite

        public SyncJob.Builder isOverwrite​(Boolean isOverwrite)
        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.

        Parameters:
        isOverwrite - the value to set
        Returns:
        this builder
      • totalObjectsScanned

        public SyncJob.Builder totalObjectsScanned​(Long totalObjectsScanned)
        Total object count for scanned files for import or export as part of this sync job.
        Parameters:
        totalObjectsScanned - the value to set
        Returns:
        this builder
      • objectsTransferred

        public SyncJob.Builder objectsTransferred​(Long objectsTransferred)
        Count of total files that transferred successfully.
        Parameters:
        objectsTransferred - the value to set
        Returns:
        this builder
      • bytesTransferred

        public SyncJob.Builder bytesTransferred​(Long bytesTransferred)
        Bytes transferred during the sync.

        This value changes while the sync is still in progress.

        Parameters:
        bytesTransferred - the value to set
        Returns:
        this builder
      • skippedErrorCount

        public SyncJob.Builder skippedErrorCount​(Long skippedErrorCount)
        Count of files or objects that failed to export or import due to errors.
        Parameters:
        skippedErrorCount - the value to set
        Returns:
        this builder
      • timeStarted

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

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

        Parameters:
        timeStarted - the value to set
        Returns:
        this builder
      • timeFinished

        public SyncJob.Builder timeFinished​(Date timeFinished)
        The date and time the job finished, expressed in RFC 3339 timestamp format.

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

        Parameters:
        timeFinished - the value to set
        Returns:
        this builder
      • lustreFileSystemPath

        public SyncJob.Builder lustreFileSystemPath​(String lustreFileSystemPath)
        The path in the Lustre file system used for this Object Storage link.

        Example: myFileSystem/mount/myDirectory

        Parameters:
        lustreFileSystemPath - the value to set
        Returns:
        this builder
      • objectStoragePath

        public SyncJob.Builder objectStoragePath​(String objectStoragePath)
        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

        Parameters:
        objectStoragePath - the value to set
        Returns:
        this builder