com.google.cloud.contactcenterinsights.v1.AnalysisOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-contact-center-insights-v1 Show documentation
Proto library for google-cloud-contact-center-insights
There is a newer version: 2.49.0
Show newest version
/*
 * Copyright 2023 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/contactcenterinsights/v1/resources.proto

package com.google.cloud.contactcenterinsights.v1;

public interface AnalysisOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.contactcenterinsights.v1.Analysis)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Immutable. The resource name of the analysis.
   * Format:
   * projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}
   * 
   *
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
   *
   * @return The name.
   */
  java.lang.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];
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Output only. The time at which the analysis was requested.
   * 
   *
   * .google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the requestTime field is set.
   */
  boolean hasRequestTime();
  /**
   *
   *
   *    * Output only. The time at which the analysis was requested.
   * 
   *
   * .google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The requestTime.
   */
  com.google.protobuf.Timestamp getRequestTime();
  /**
   *
   *
   *    * Output only. The time at which the analysis was requested.
   * 
   *
   * .google.protobuf.Timestamp request_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getRequestTimeOrBuilder();

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the createTime field is set.
   */
  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];
   * 
   *
   * @return The createTime.
   */
  com.google.protobuf.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];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the analysisResult field is set.
   */
  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];
   * 
   *
   * @return The analysisResult.
   */
  com.google.cloud.contactcenterinsights.v1.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];
   * 
   */
  com.google.cloud.contactcenterinsights.v1.AnalysisResultOrBuilder getAnalysisResultOrBuilder();

  /**
   *
   *
   *    * 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;
   *
   * @return Whether the annotatorSelector field is set.
   */
  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;
   *
   * @return The annotatorSelector.
   */
  com.google.cloud.contactcenterinsights.v1.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;
   */
  com.google.cloud.contactcenterinsights.v1.AnnotatorSelectorOrBuilder
      getAnnotatorSelectorOrBuilder();
}