Package com.oracle.bmc.ailanguage.model

Class JobSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class JobSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    sub set of Job details data which need returns in list API
    Note: Objects should always be created or deserialized using the JobSummary.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 JobSummary.Builder, which maintain a set of all explicitly set fields called JobSummary.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).

    • Constructor Detail

      • JobSummary

        @Deprecated
@ConstructorProperties({"id","displayName","description","compartmentId","lifecycleState","lifecycleDetails","percentComplete","totalDocuments","pendingDocuments","completedDocuments","failedDocuments","warningsCount","createdBy","timeAccepted","timeStarted","timeCompleted"})
public JobSummary​(String id,
                  String displayName,
                  String description,
                  String compartmentId,
                  Job.LifecycleState lifecycleState,
                  String lifecycleDetails,
                  Integer percentComplete,
                  Integer totalDocuments,
                  Integer pendingDocuments,
                  Integer completedDocuments,
                  Integer failedDocuments,
                  Integer warningsCount,
                  String createdBy,
                  Date timeAccepted,
                  Date timeStarted,
                  Date timeCompleted)
        Deprecated.

    • Method Detail

      • getId

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

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name for the job.
        Returns:
        the value

      • getDescription

        public String getDescription()
        A short description of the job.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where you want to create the job.
        Returns:
        the value

      • getLifecycleState

        public Job.LifecycleState getLifecycleState()
        The current state of the Speech Job.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

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

        Returns:
        the value

      • getPercentComplete

        public Integer getPercentComplete()
        How much progress the operation has made, vs the total amount of work that must be performed.
        Returns:
        the value

      • getTotalDocuments

        public Integer getTotalDocuments()
        Total number of documents given as input for prediction.

        For CSV this signifies number of rows and for TXT this signifies number of files.

        Returns:
        the value

      • getPendingDocuments

        public Integer getPendingDocuments()
        Number of documents still to process.

        For CSV this signifies number of rows and for TXT this signifies number of files.

        Returns:
        the value

      • getCompletedDocuments

        public Integer getCompletedDocuments()
        Number of documents processed for prediction.

        For CSV this signifies number of rows and for TXT this signifies number of files.

        Returns:
        the value

      • getFailedDocuments

        public Integer getFailedDocuments()
        Number of documents failed for prediction.

        For CSV this signifies number of rows and for TXT this signifies number of files.

        Returns:
        the value

      • getWarningsCount

        public Integer getWarningsCount()
        warnings count
        Returns:
        the value

      • getCreatedBy

        public String getCreatedBy()
        The OCID of the user who created the job.
        Returns:
        the value

      • getTimeAccepted

        public Date getTimeAccepted()
        Job accepted time.
        Returns:
        the value

      • getTimeStarted

        public Date getTimeStarted()
        Job started time.
        Returns:
        the value

      • getTimeCompleted

        public Date getTimeCompleted()
        Job finished time.
        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