BatchTranslateMetadataOrBuilder.java

/*
 * Copyright 2019 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/translate/v3/translation_service.proto

package com.google.cloud.translate.v3;

public interface BatchTranslateMetadataOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.translation.v3.BatchTranslateMetadata)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The state of the operation.
   * </pre>
   *
   * <code>.google.cloud.translation.v3.BatchTranslateMetadata.State state = 1;</code>
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   * <pre>
   * The state of the operation.
   * </pre>
   *
   * <code>.google.cloud.translation.v3.BatchTranslateMetadata.State state = 1;</code>
   *
   * @return The state.
   */
  com.google.cloud.translate.v3.BatchTranslateMetadata.State getState();

  /**
   *
   *
   * <pre>
   * Number of successfully translated characters so far (Unicode codepoints).
   * </pre>
   *
   * <code>int64 translated_characters = 2;</code>
   *
   * @return The translatedCharacters.
   */
  long getTranslatedCharacters();

  /**
   *
   *
   * <pre>
   * Number of characters that have failed to process so far (Unicode
   * codepoints).
   * </pre>
   *
   * <code>int64 failed_characters = 3;</code>
   *
   * @return The failedCharacters.
   */
  long getFailedCharacters();

  /**
   *
   *
   * <pre>
   * Total number of characters (Unicode codepoints).
   * This is the total number of codepoints from input files times the number of
   * target languages and appears here shortly after the call is submitted.
   * </pre>
   *
   * <code>int64 total_characters = 4;</code>
   *
   * @return The totalCharacters.
   */
  long getTotalCharacters();

  /**
   *
   *
   * <pre>
   * Time when the operation was submitted.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp submit_time = 5;</code>
   *
   * @return Whether the submitTime field is set.
   */
  boolean hasSubmitTime();
  /**
   *
   *
   * <pre>
   * Time when the operation was submitted.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp submit_time = 5;</code>
   *
   * @return The submitTime.
   */
  com.google.protobuf.Timestamp getSubmitTime();
  /**
   *
   *
   * <pre>
   * Time when the operation was submitted.
   * </pre>
   *
   * <code>.google.protobuf.Timestamp submit_time = 5;</code>
   */
  com.google.protobuf.TimestampOrBuilder getSubmitTimeOrBuilder();
}