com.google.cloud.documentai.v1beta3.ProcessorVersionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-document-ai-v1beta3 Show documentation
PROTO library for proto-google-cloud-document-ai-v1beta3
There is a newer version: 0.71.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/documentai/v1beta3/processor.proto

// Protobuf Java Version: 3.25.2
package com.google.cloud.documentai.v1beta3;

public interface ProcessorVersionOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.ProcessorVersion)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The resource name of the processor version.
   * Format:
   * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * The resource name of the processor version.
   * Format:
   * `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The display name of the processor version.
   * 
   *
   * string display_name = 2;
   *
   * @return The displayName.
   */
  java.lang.String getDisplayName();
  /**
   *
   *
   *    * The display name of the processor version.
   * 
   *
   * string display_name = 2;
   *
   * @return The bytes for displayName.
   */
  com.google.protobuf.ByteString getDisplayNameBytes();

  /**
   *
   *
   *    * The schema of the processor version. Describes the output.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 12;
   *
   * @return Whether the documentSchema field is set.
   */
  boolean hasDocumentSchema();
  /**
   *
   *
   *    * The schema of the processor version. Describes the output.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 12;
   *
   * @return The documentSchema.
   */
  com.google.cloud.documentai.v1beta3.DocumentSchema getDocumentSchema();
  /**
   *
   *
   *    * The schema of the processor version. Describes the output.
   * 
   *
   * .google.cloud.documentai.v1beta3.DocumentSchema document_schema = 12;
   */
  com.google.cloud.documentai.v1beta3.DocumentSchemaOrBuilder getDocumentSchemaOrBuilder();

  /**
   *
   *
   *    * The state of the processor version.
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessorVersion.State state = 6;
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * The state of the processor version.
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessorVersion.State state = 6;
   *
   * @return The state.
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersion.State getState();

  /**
   *
   *
   *    * The time the processor version was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   *    * The time the processor version was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   *    * The time the processor version was created.
   * 
   *
   * .google.protobuf.Timestamp create_time = 7;
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   *    * The most recently invoked evaluation for the processor version.
   * 
   *
   * .google.cloud.documentai.v1beta3.EvaluationReference latest_evaluation = 8;
   *
   * @return Whether the latestEvaluation field is set.
   */
  boolean hasLatestEvaluation();
  /**
   *
   *
   *    * The most recently invoked evaluation for the processor version.
   * 
   *
   * .google.cloud.documentai.v1beta3.EvaluationReference latest_evaluation = 8;
   *
   * @return The latestEvaluation.
   */
  com.google.cloud.documentai.v1beta3.EvaluationReference getLatestEvaluation();
  /**
   *
   *
   *    * The most recently invoked evaluation for the processor version.
   * 
   *
   * .google.cloud.documentai.v1beta3.EvaluationReference latest_evaluation = 8;
   */
  com.google.cloud.documentai.v1beta3.EvaluationReferenceOrBuilder getLatestEvaluationOrBuilder();

  /**
   *
   *
   *    * The KMS key name used for encryption.
   * 
   *
   * string kms_key_name = 9;
   *
   * @return The kmsKeyName.
   */
  java.lang.String getKmsKeyName();
  /**
   *
   *
   *    * The KMS key name used for encryption.
   * 
   *
   * string kms_key_name = 9;
   *
   * @return The bytes for kmsKeyName.
   */
  com.google.protobuf.ByteString getKmsKeyNameBytes();

  /**
   *
   *
   *    * The KMS key version with which data is encrypted.
   * 
   *
   * string kms_key_version_name = 10;
   *
   * @return The kmsKeyVersionName.
   */
  java.lang.String getKmsKeyVersionName();
  /**
   *
   *
   *    * The KMS key version with which data is encrypted.
   * 
   *
   * string kms_key_version_name = 10;
   *
   * @return The bytes for kmsKeyVersionName.
   */
  com.google.protobuf.ByteString getKmsKeyVersionNameBytes();

  /**
   *
   *
   *    * Output only. Denotes that this `ProcessorVersion` is managed by Google.
   * 
   *
   * bool google_managed = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The googleManaged.
   */
  boolean getGoogleManaged();

  /**
   *
   *
   *    * If set, information about the eventual deprecation of this version.
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfo deprecation_info = 13;
   * 
   *
   * @return Whether the deprecationInfo field is set.
   */
  boolean hasDeprecationInfo();
  /**
   *
   *
   *    * If set, information about the eventual deprecation of this version.
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfo deprecation_info = 13;
   * 
   *
   * @return The deprecationInfo.
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfo getDeprecationInfo();
  /**
   *
   *
   *    * If set, information about the eventual deprecation of this version.
   * 
   *
   * .google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfo deprecation_info = 13;
   * 
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersion.DeprecationInfoOrBuilder
      getDeprecationInfoOrBuilder();

  /**
   *
   *
   *    * Output only. The model type of this processor version.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.ProcessorVersion.ModelType model_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for modelType.
   */
  int getModelTypeValue();
  /**
   *
   *
   *    * Output only. The model type of this processor version.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.ProcessorVersion.ModelType model_type = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The modelType.
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersion.ModelType getModelType();
}