Class Analysis (2.28.0)

public final class Analysis extends GeneratedMessageV3 implements AnalysisOrBuilder

The analysis resource.

Protobuf type google.cloud.contactcenterinsights.v1.Analysis

Implements

AnalysisOrBuilder

Static Fields

ANALYSIS_RESULT_FIELD_NUMBER

public static final int ANALYSIS_RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

ANNOTATOR_SELECTOR_FIELD_NUMBER

public static final int ANNOTATOR_SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_TIME_FIELD_NUMBER

public static final int REQUEST_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Analysis getDefaultInstance()
Returns
TypeDescription
Analysis

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Analysis.Builder newBuilder()
Returns
TypeDescription
Analysis.Builder

newBuilder(Analysis prototype)

public static Analysis.Builder newBuilder(Analysis prototype)
Parameter
NameDescription
prototypeAnalysis
Returns
TypeDescription
Analysis.Builder

parseDelimitedFrom(InputStream input)

public static Analysis parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Analysis parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Analysis parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Analysis parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Analysis parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Analysis parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Analysis
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Analysis> parser()
Returns
TypeDescription
Parser<Analysis>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnalysisResult()

public AnalysisResult getAnalysisResult()

Output only. The result of the analysis, which is populated when the analysis finishes.

.google.cloud.contactcenterinsights.v1.AnalysisResult analysis_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AnalysisResult

The analysisResult.

getAnalysisResultOrBuilder()

public AnalysisResultOrBuilder getAnalysisResultOrBuilder()

Output only. The result of the analysis, which is populated when the analysis finishes.

.google.cloud.contactcenterinsights.v1.AnalysisResult analysis_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
AnalysisResultOrBuilder

getAnnotatorSelector()

public AnnotatorSelector getAnnotatorSelector()

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 8;

Returns
TypeDescription
AnnotatorSelector

The annotatorSelector.

getAnnotatorSelectorOrBuilder()

public AnnotatorSelectorOrBuilder getAnnotatorSelectorOrBuilder()

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 8;

Returns
TypeDescription
AnnotatorSelectorOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Analysis getDefaultInstanceForType()
Returns
TypeDescription
Analysis

getName()

public String getName()

Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Analysis> getParserForType()
Returns
TypeDescription
Parser<Analysis>
Overrides

getRequestTime()

public Timestamp getRequestTime()

Output only. The time at which the analysis was requested.

.google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The requestTime.

getRequestTimeOrBuilder()

public TimestampOrBuilder getRequestTimeOrBuilder()

Output only. The time at which the analysis was requested.

.google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasAnalysisResult()

public boolean hasAnalysisResult()

Output only. The result of the analysis, which is populated when the analysis finishes.

.google.cloud.contactcenterinsights.v1.AnalysisResult analysis_result = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the analysisResult field is set.

hasAnnotatorSelector()

public boolean hasAnnotatorSelector()

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.

.google.cloud.contactcenterinsights.v1.AnnotatorSelector annotator_selector = 8;

Returns
TypeDescription
boolean

Whether the annotatorSelector field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time at which the analysis was created, which occurs when the long-running operation completes.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasRequestTime()

public boolean hasRequestTime()

Output only. The time at which the analysis was requested.

.google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the requestTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Analysis.Builder newBuilderForType()
Returns
TypeDescription
Analysis.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Analysis.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Analysis.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Analysis.Builder toBuilder()
Returns
TypeDescription
Analysis.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException