com.google.cloud.translate.v3beta1.BatchTranslateDocumentMetadataOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-translate-v3beta1 Show documentation
PROTO library for proto-google-cloud-translate-v3beta1
There is a newer version: 0.136.0
Show newest version
/*
 * Copyright 2024 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/v3beta1/translation_service.proto

// Protobuf Java Version: 3.25.4
package com.google.cloud.translate.v3beta1;

public interface BatchTranslateDocumentMetadataOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The state of the operation.
   * 
   *
   * .google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata.State state = 1;
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * The state of the operation.
   * 
   *
   * .google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata.State state = 1;
   *
   * @return The state.
   */
  com.google.cloud.translate.v3beta1.BatchTranslateDocumentMetadata.State getState();

  /**
   *
   *
   *    * Total number of pages to translate in all documents so far. Documents
   * without clear page definition (such as XLSX) are not counted.
   * 
   *
   * int64 total_pages = 2;
   *
   * @return The totalPages.
   */
  long getTotalPages();

  /**
   *
   *
   *    * Number of successfully translated pages in all documents so far. Documents
   * without clear page definition (such as XLSX) are not counted.
   * 
   *
   * int64 translated_pages = 3;
   *
   * @return The translatedPages.
   */
  long getTranslatedPages();

  /**
   *
   *
   *    * Number of pages that failed to process in all documents so far. Documents
   * without clear page definition (such as XLSX) are not counted.
   * 
   *
   * int64 failed_pages = 4;
   *
   * @return The failedPages.
   */
  long getFailedPages();

  /**
   *
   *
   *    * Number of billable pages in documents with clear page definition (such as
   * PDF, DOCX, PPTX) so far.
   * 
   *
   * int64 total_billable_pages = 5;
   *
   * @return The totalBillablePages.
   */
  long getTotalBillablePages();

  /**
   *
   *
   *    * Total number of characters (Unicode codepoints) in all documents so far.
   * 
   *
   * int64 total_characters = 6;
   *
   * @return The totalCharacters.
   */
  long getTotalCharacters();

  /**
   *
   *
   *    * Number of successfully translated characters (Unicode codepoints) in all
   * documents so far.
   * 
   *
   * int64 translated_characters = 7;
   *
   * @return The translatedCharacters.
   */
  long getTranslatedCharacters();

  /**
   *
   *
   *    * Number of characters that have failed to process (Unicode codepoints) in
   * all documents so far.
   * 
   *
   * int64 failed_characters = 8;
   *
   * @return The failedCharacters.
   */
  long getFailedCharacters();

  /**
   *
   *
   *    * Number of billable characters (Unicode codepoints) in documents without
   * clear page definition (such as XLSX) so far.
   * 
   *
   * int64 total_billable_characters = 9;
   *
   * @return The totalBillableCharacters.
   */
  long getTotalBillableCharacters();

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