com.google.cloud.documentai.v1beta3.ProcessorOrBuilder 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 ProcessorOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.documentai.v1beta3.Processor)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Output only. Immutable. The resource name of the processor.
   * Format: `projects/{project}/locations/{location}/processors/{processor}`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Output only. Immutable. The resource name of the processor.
   * Format: `projects/{project}/locations/{location}/processors/{processor}`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
   * To get a list of processor types, see
   * [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
   * 
   *
   * string type = 2;
   *
   * @return The type.
   */
  java.lang.String getType();
  /**
   *
   *
   *    * The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
   * To get a list of processor types, see
   * [FetchProcessorTypes][google.cloud.documentai.v1beta3.DocumentProcessorService.FetchProcessorTypes].
   * 
   *
   * string type = 2;
   *
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString getTypeBytes();

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

  /**
   *
   *
   *    * Output only. The state of the processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   *    * Output only. The state of the processor.
   * 
   *
   * 
   * .google.cloud.documentai.v1beta3.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The state.
   */
  com.google.cloud.documentai.v1beta3.Processor.State getState();

  /**
   *
   *
   *    * The default processor version.
   * 
   *
   * string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
   *
   * @return The defaultProcessorVersion.
   */
  java.lang.String getDefaultProcessorVersion();
  /**
   *
   *
   *    * The default processor version.
   * 
   *
   * string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for defaultProcessorVersion.
   */
  com.google.protobuf.ByteString getDefaultProcessorVersionBytes();

  /**
   *
   *
   *    * Output only. The processor version aliases.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  java.util.List
      getProcessorVersionAliasesList();
  /**
   *
   *
   *    * Output only. The processor version aliases.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersionAlias getProcessorVersionAliases(int index);
  /**
   *
   *
   *    * Output only. The processor version aliases.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  int getProcessorVersionAliasesCount();
  /**
   *
   *
   *    * Output only. The processor version aliases.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  java.util.List
      getProcessorVersionAliasesOrBuilderList();
  /**
   *
   *
   *    * Output only. The processor version aliases.
   * 
   *
   * 
   * repeated .google.cloud.documentai.v1beta3.ProcessorVersionAlias processor_version_aliases = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.cloud.documentai.v1beta3.ProcessorVersionAliasOrBuilder
      getProcessorVersionAliasesOrBuilder(int index);

  /**
   *
   *
   *    * Output only. Immutable. The http endpoint that can be called to invoke
   * processing.
   * 
   *
   * 
   * string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The processEndpoint.
   */
  java.lang.String getProcessEndpoint();
  /**
   *
   *
   *    * Output only. Immutable. The http endpoint that can be called to invoke
   * processing.
   * 
   *
   * 
   * string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
   * 
   *
   * @return The bytes for processEndpoint.
   */
  com.google.protobuf.ByteString getProcessEndpointBytes();

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

  /**
   *
   *
   *    * The [KMS key](https://cloud.google.com/security-key-management) used for
   * encryption and decryption in CMEK scenarios.
   * 
   *
   * string kms_key_name = 8;
   *
   * @return The kmsKeyName.
   */
  java.lang.String getKmsKeyName();
  /**
   *
   *
   *    * The [KMS key](https://cloud.google.com/security-key-management) used for
   * encryption and decryption in CMEK scenarios.
   * 
   *
   * string kms_key_name = 8;
   *
   * @return The bytes for kmsKeyName.
   */
  com.google.protobuf.ByteString getKmsKeyNameBytes();
}