Package com.oracle.bmc.aispeech.model

Class TranscriptionJobSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.aispeech.model.TranscriptionJobSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220101")
public final class TranscriptionJobSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Summary of the Transcription Job.
Note: Objects should always be created or deserialized using the TranscriptionJobSummary.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 TranscriptionJobSummary.Builder, which maintain a set of all explicitly set fields called TranscriptionJobSummary.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TranscriptionJobSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

TranscriptionJobSummary(String id, String displayName, String compartmentId, String createdBy, Integer percentComplete, Date timeAccepted, Date timeStarted, Date timeFinished, Integer totalTasks, Integer outstandingTasks, Integer successfulTasks, TranscriptionJob.LifecycleState lifecycleState, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static TranscriptionJobSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment where you want to create the job.
String	getCreatedBy()	The OCID of the user who created the job.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDisplayName()	A user-friendly display name for the job.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	The OCID of the job.
String	getLifecycleDetails()	A message describing the current state in more detail.
TranscriptionJob.LifecycleState	getLifecycleState()	The current state of the Speech Job.
Integer	getOutstandingTasks()	Total outstanding tasks in a job.
Integer	getPercentComplete()	How much progress the operation has made, vs the total amount of work that must be performed.
Integer	getSuccessfulTasks()	Total successful tasks in a job.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeAccepted()	Job accepted time.
Date	getTimeFinished()	Job finished time.
Date	getTimeStarted()	Job started time.
Integer	getTotalTasks()	Total number of tasks in a job.
int	hashCode()
TranscriptionJobSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TranscriptionJobSummary

@Deprecated
@ConstructorProperties({"id","displayName","compartmentId","createdBy","percentComplete","timeAccepted","timeStarted","timeFinished","totalTasks","outstandingTasks","successfulTasks","lifecycleState","lifecycleDetails","freeformTags","definedTags","systemTags"})
public TranscriptionJobSummary(String id,
                               String displayName,
                               String compartmentId,
                               String createdBy,
                               Integer percentComplete,
                               Date timeAccepted,
                               Date timeStarted,
                               Date timeFinished,
                               Integer totalTasks,
                               Integer outstandingTasks,
                               Integer successfulTasks,
                               TranscriptionJob.LifecycleState lifecycleState,
                               String lifecycleDetails,
                               Map<String,String> freeformTags,
                               Map<String,Map<String,Object>> definedTags,
                               Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static TranscriptionJobSummary.Builder builder()

Create a new builder.

toBuilder

public TranscriptionJobSummary.Builder toBuilder()

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

getCompartmentId

public String getCompartmentId()

The OCID of the compartment where you want to create the job.

Returns:

the value

getCreatedBy

public String getCreatedBy()

The OCID of the user who created the job.

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

getTimeAccepted

public Date getTimeAccepted()

Job accepted time.

Returns:

the value

getTimeStarted

public Date getTimeStarted()

Job started time.

Returns:

the value

getTimeFinished

public Date getTimeFinished()

Job finished time.

Returns:

the value

getTotalTasks

public Integer getTotalTasks()

Total number of tasks in a job.

Returns:

the value

getOutstandingTasks

public Integer getOutstandingTasks()

Total outstanding tasks in a job.

Returns:

the value

getSuccessfulTasks

public Integer getSuccessfulTasks()

Total successful tasks in a job.

Returns:

the value

getLifecycleState

public TranscriptionJob.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

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

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. Example: {“foo-namespace-1”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}, “foo-namespace-2”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}}.

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

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