Class Analysis (2.42.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
Type Description
int

ANNOTATOR_SELECTOR_FIELD_NUMBER

public static final int ANNOTATOR_SELECTOR_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_TIME_FIELD_NUMBER

public static final int REQUEST_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Analysis getDefaultInstance()
Returns
Type Description
Analysis

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Analysis.Builder newBuilder()
Returns
Type Description
Analysis.Builder

newBuilder(Analysis prototype)

public static Analysis.Builder newBuilder(Analysis prototype)
Parameter
Name Description
prototype Analysis
Returns
Type Description
Analysis.Builder

parseDelimitedFrom(InputStream input)

public static Analysis parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Analysis parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Analysis parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Analysis parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Analysis parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Analysis parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Analysis parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Analysis
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Analysis> parser()
Returns
Type Description
Parser<Analysis>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Analysis getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Analysis> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the requestTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Analysis.Builder newBuilderForType()
Returns
Type Description
Analysis.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Analysis.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Analysis.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Analysis.Builder toBuilder()
Returns
Type Description
Analysis.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException